Service de statistiques |
|
DéfinitionLe service de statistiques vous permet de récupérer l'ensemble de vos statistiques sur une (ou plusieurs) campagne(s) donnée(s) ou sur une période définie. Récupérer vos statistiques globales de campagnes, vos ouvertures, vos clics, vos désabonnés...et intégrer les directement dans votre système d'informations.
|
Principe fonctionnementVoici quelques règles de fonctionnement pour utiliser au mieux nos API de statistiques.
- Il faut passer au minimum une liste campagne (une seule est également possible) ou une période de dates pour avoir un résultat.
- Spécifier un seul numéro d’envoi (CampaignChildID) pour plusieurs campagnes donnera un résultat incohérent.
- L’entité gestionnaire ou le segment sont utilisables seulement pour les campagnes non archivées.
- Les statistiques sur le nombre d’aboutis/bounce/pending seront vides si un segment ou une entité gestionnaire est spécifié ainsi que les 30 jours d'envoi de la campagne ont été dépassées.
- L’IGQ n'est pas statique. Il peut être modifié sur une même campagne tant que la période de calcul n’est pas terminée.
- Campagnes de Trigger Marketing / Campagne de Personnalisation Dynamique : Des doublons peuvent être retournés si une campagne mère et une campagne fille sont dans la liste de campagnes.
- Le segment doit être un identifiant valide et supérieur à 0.
- L'entité gestionnaire doit être présente dans la base.
- Les valeurs retournées peuvent être vides dans le cas de l’utilisation d’un segment dans lequel aucun contact n’a fait partie de l’envoi.
|
Statistiques sur les clicsNom de la méthode : GetClickStatsCette méthode vous permet de récupérer le nombre total de clics ainsi que les informations relatives au clic (date, lien cliqué...)
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
GetClickStatsResult | Objet contenant la liste des statistiques de clic ainsi que leur nombre |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques sur la réceptionNom de la méthode : GetDeliveryStatsCette méthode vous permet de récupérer le nombre total de messages aboutis ainsi que les informations relatives au contact qui a reçu le message.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
GetDeliveryStatsResult | Objet contenant la liste des statistiques de réception ainsi que leur nombre |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques sur les hardbounceNom de la méthode : GetHardbounceStatsCette méthode vous permet de récupérer le nombre total de messages non aboutis (Hardbounce) ainsi que les raisons de non-réception pour chacun. | Les logs SMTP de vos campagnes sont disponibles pendant les 30 jours qui suivent la date d'envoi de vos campagnes.
|
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques sur les ouverturesNom de la méthode : GetOpenStatsCette méthode vous permet de récupérer le nombre total de messages ouverts ainsi que les informations relatives à l'ouverture du message (date d'ouverture, contact qui a ouvert...)
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
GetOpenStatsResult | Objet contenant la liste des statistiques d'ouverture ainsi que leur nombre |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques sur le trackingNom de la méthode : GetTrackingStatsCette méthode vous permet de récupérer le nombre total de clics par lien défini.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
GetTrackingStatsResult | Objet contenant la liste des statistiques de tracking ainsi que leur nombre |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques sur les desabonnementsNom de la méthode : GetUnsubscribeStatsCette méthode vous permet de récupérer le nombre total de désabonnés (Hardbounce) ainsi que les informations relatives au contact
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques sur le parrainageNom de la méthode : GetSponsorshipStatsCette méthode vous permet de récupérer le nombre total de parrainages ainsi que le descriptif des différents parrainages (parrain, adresse email filleule convertie,...)
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 107 | SegmentNotFoundException | Le segment demandé n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible |
|
|
Statistiques des campagnesNom de la méthode : GetCampaignStatsCette méthode vous retourne les statistiques globales de vos campagnes.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
GetCampaignStatsResult | Objet contenant la liste des statistiques de campagne ainsi que leurs nombres |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques agrégées des campagnesNom de la méthode : GetCampaignAggregatedStatsCette méthode vous retourne les statistiques globales de vos campagnes, agrégées par envois, sur une période de regroupement donnée.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée | 921 | TooLongEventPeriodException | Période de recherche des statistiques dépassée | 922 | InvalidEventDatePeriodException | Date de recherche des statistiques incorrecte |
|
|
Statistiques des liens de trackingNom de la méthode : GetCampaignTrackingLinkStatsCette méthode vous retourne les statistiques globales par lien ainsi que le nombre de clics brut et distinct.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques globales des réseaux sociauxNom de la méthode : GetCampaignSocialNetworkStatsCette méthode vous retourne le nombre de sociaunotes acquis ou global de votre base pour une ou plusieurs campagnes données.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques des liens de réseaux sociauxNom de la méthode : GetCampaignSocialNetworkClickStatsCette méthode vous retourne la ventilation de vos statistiques de clics par lien par sociaunotes pour vos campagnes.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Statistiques des domaines des campagnesNom de la méthode : GetCampaignDomainStatsCette méthode vous retourne la ventilation de vos statistiques comportementales par domaine pour vos campagnes.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
|
Liste des erreurs possibles |
Erreurs communes |
Code | Nom | Description |
---|
107 | SegmentNotFoundException | Le segment demandé n'existe pas | 409 | SaleManagerNotFoundException | L'entité gestionnaire demandée n'existe pas | 503 | InvalidStatsFilterException | Vous devez donner une liste d'identifiants de campagne ou une période | 504 | InvalidSortFieldException | Le champ de tri spécifié n'est pas disponible | 920 | TooLongPeriodException | Période de recherche de la campagne dépassée |
|
|
Les objets du service de statistiques |
AuthenticationTokenContext |
|
Champ | Type | Description |
---|
AccountID | int | Identifiant du client | Key | string | Clé du jeton d'authentification | ListID | int | Identifiant du client: obsolète. Utilisez AccountID à la place |
|
GetClickStatsRequest |
la classe hérite de : BaseMemberStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date de clics réalisés sur les messages.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans. - CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour StaticFieldList sont :
- MemberID : Identifiant du contact
- ThemeID : Identifiant du thème associé au lien
- ThemeName : Description du thème
- Optout : Identifiant de l’etat du contact email
- Mobile : Numéro de télephone Mobile
- OptoutMobile : Identifiant de l’etat du contact mobile
- SalutationID : Identifiant de la civilité
- SaleMgtID : Identifiant de l’entité gestionnaire
- CountryID : Identifiant du pays
- JoinDate : Date d’insertion du contact en base
- LeaveDate : Date de passage du contact en inactif
- Optin : Identifiant de l’origine du contact
- ProfileUpdateDate : Date de mise à jour du profil du contact
- LastOpenDate: Date de dernière ouverture du contact
- LastClickDate: Date de dernier clic du contact
- SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
- DeviceID : Identifiant du support de consultation
- DeviceName : Nom du support de consultation
- ModelID : Identifiant du modèle
- ModelName : Nom du modèle
- BrandID : Identifiant de la marque
- BrandName : Nom de la marque
- OsID : Identifiant du système d'exploitation
- OsName : Nom du système d'exploitation
- BrowserID : Identifiant du navigateur
- BrowserName : Nom du navigateur
- UserAgentID : Identifiant du user agent
- UserAgentName : Nom du user agent
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
BaseMemberStatsRequest |
la classe hérite de : BaseCampaignStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner |
|
BaseCampaignStatsRequest |
la classe hérite de : BaseServiceRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner |
|
BaseServiceRequest |
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur |
|
GetClickStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de clics | ClickStatsList | ClickStats[]
| Liste des statistiques de clics |
|
ClickStats |
la classe hérite de : BaseMemberStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total | LinkID | int | Identifiant du lien | Url | string | URL du lien |
- EventDate : Date de clic
- EventDistinct : Nombre de clics distincts
- EventTotal : Nombre de clics total
|
BaseMemberStats |
la classe hérite de : BaseStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total |
|
BaseStats |
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner |
|
StaticFieldValue |
|
Champ | Type | Description |
---|
Name | string | Nom système du champ retourné | Value | string | Valeur du champ |
|
CustomFieldValue |
|
Champ | Type | Description |
---|
ID | int | Identifiant du champ | Value | string | Valeur du champ |
|
GetDeliveryStatsRequest |
la classe hérite de : BaseMemberStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d'abouti du contact.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans. - CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- Optout : Identifiant de l’état du contact email
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’état du contact mobile
- SalutationID : Identifiant de la civilité
- SaleMgtID : Identifiant de l’entité gestionnaire
- CountryID : Identifiant du pays
- JoinDate : Date d’insertion du contact en base
- LeaveDate : Date de passage du contact en inactif
- Optin : Identifiant de l’origine du contact
- ProfileUpdateDate : Date de mise à jour du profil du contact
- LastOpenDate : Date de dernière ouverture du contact
- LastClickDate : Date de dernier clic du contact
- SentEmail: Nombre de message envoyés sur ce contact depuis son inscription
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetDeliveryStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de réception | DeliveryStatsList | DeliveryStats[]
| Liste des statistiques de réception |
|
DeliveryStats |
la classe hérite de : BaseMemberStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total |
- EventDate : Date d'abouti
- EventDistinct : Nombre d'aboutis du contact sur la campagne
- EventTotal : Nombre d'aboutis total
|
GetHardbounceStatsRequest |
la classe hérite de : BaseMemberStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date de hardbounce du contact.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans. - CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- Optout : Identifiant de l’etat du contact email
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’etat du contact mobile
- SalutationID : Identifiant de la civilité
- SaleMgtID : Identifiant de l’entité gestionnaire
- CountryID : Identifiant du pays
- JoinDate : Date d’insertion du contact en base
- LeaveDate : Date de passage du contact en inactif
- Optin : Identifiant de l’origine du contact
- ProfileUpdateDate : Date de mise à jour du profil du contact
- LastOpenDate : Date de dernière ouverture du contact
- LastClickDate : Date de dernier clic du contact
- SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetHardbounceStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de hardbounce | HardbounceStatsList | HardbounceStats[]
| Liste des statistiques de hardbounce |
|
HardbounceStats |
la classe hérite de : BaseMemberStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total |
- EventDate : Date d'injoignable
- EventDistinct : Nombre de harbounces du contact sur la campagne
- EventTotal : Nombre d'injoignables total
|
GetOpenStatsRequest |
la classe hérite de : BaseMemberStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner |
- CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- Optout : Identifiant de l’etat du contact email
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’etat du contact mobile
- SalutationID : Identifiant de la civilité
- SaleMgtID : Identifiant de l’entité gestionnaire
- CountryID : Identifiant du pays
- JoinDate : Date d’insertion du contact en base
- LeaveDate : Date de passage du contact en inactif
- Optin : Identifiant de l’origine du contact
- ProfileUpdateDate : Date de mise à jour du profil du contact
- LastOpenDate : Date de dernière ouverture du contact
- LastClickDate : Date de dernier clic du contact
- SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
- DeviceID : Identifiant du support de consultation
- DeviceName : Nom du support de consultation
- ModelID : Identifiant du modèle
- ModelName : Nom du modèle
- BrandID : Identifiant de la marque
- BrandName : Nom de la marque
- OsID : Identifiant du système d'exploitation
- OsName : Nom du système d'exploitation
- BrowserID : Identifiant du navigateur
- BrowserName : Nom du navigateur
- UserAgentID : Identifiant du user agent
- UserAgentName : Nom du user agent
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetOpenStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques d'ouverture | OpenStatsList | OpenStats[]
| Liste des statistiques d'ouverture |
|
OpenStats |
la classe hérite de : BaseMemberStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total |
- EventDate : Date d'ouverture
- EventDistinct : Nombre d'ouvertures distinctes
- EventTotal : Nombre d'ouvertures total
|
GetTrackingStatsRequest |
la classe hérite de : BaseMemberStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner | LinkIDList | int[]
| (Facultatif) - Liste des identifiants de lien |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date du clic du contact sur lien défini.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans. - CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- ThemeID : Identifiant du thème associé au lien
- ThemeName : Description du thème
- Optout : Identifiant de l’etat du contact email
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’etat du contact mobile
- SalutationID : Identifiant de la civilité
- SaleMgtID : Identifiant de l’entité gestionnaire
- CountryID : Identifiant du pays
- JoinDate : Date d’insertion du contact en base
- LeaveDate : Date de passage du contact en inactif
- Optin : Identifiant de l’origine du contact
- ProfileUpdateDate : Date de mise à jour du profil du contact
- LastOpenDate: Date de dernière ouverture du contact
- LastClickDate: Date de dernier clic du contact
- SentEmail: Nombre de message envoyés sur ce contact depuis son inscription
- DeviceID : Identifiant du support de consultation
- DeviceName : Nom du support de consultation
- ModelID : Identifiant du modèle
- ModelName : Nom du modèle
- BrandID : Identifiant de la marque
- BrandName : Nom de la marque
- OsID : Identifiant du système d'exploitation
- OsName : Nom du système d'exploitation
- BrowserID : Identifiant du navigateur
- BrowserName : Nom du navigateur
- UserAgentID : Identifiant du user agent
- UserAgentName : Nom du user agent
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetTrackingStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de tracking | TrackingStatsList | TrackingStats[]
| Liste des statistiques de tracking |
|
TrackingStats |
la classe hérite de : BaseMemberStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total | LinkID | int | Identifiant du lien | Url | string | URL du lien |
- EventDate : Date de clic sur le lien
- EventDistinct : Nombre de clics distincts sur le lien
- EventTotal : Nombre de clics totals sur le lien
|
GetUnsubscribeStatsRequest |
la classe hérite de : BaseMemberStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date de désabonnement du contact.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans. - CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- Optout : Identifiant de l’etat du contact email
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’etat du contact mobile
- SalutationID : Identifiant de la civilité
- SaleMgtID : Identifiant de l’entité gestionnaire
- CountryID : Identifiant du pays
- JoinDate : Date d’insertion du contact en base
- LeaveDate : Date de passage du contact en inactif
- Optin : Identifiant de l’origine du contact
- ProfileUpdateDate : Date de mise à jour du profil du contact
- LastOpenDate : Date de dernière ouverture du contact
- LastClickDate : Date de dernier clic du contact
- SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetUnsubscribeStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de désabonnement | UnsubscribeStatsList | UnsubscribeStats[]
| Liste des statistiques de désabonnement |
|
UnsubscribeStats |
la classe hérite de : BaseMemberStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total |
- EventDate : Date de désabonnement
- EventDistinct : Nombre de désinscription du contact sur la campagne
- EventTotal : Nombre de désabonnements
|
|
la classe hérite de : BaseMemberStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner | SponsorshipIDList | int[]
| (Facultatif) - Liste des identifiants de parrainage |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date de parrainage du contact.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans. - CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact qui a parrainé
- GodSonEmail : Adresse email du filleul
- QuizzID : Identifiant du quizz a l’origine du parrainage
- ContestID : Identifiant du jeu concours a l’origine du parrainage
- Optout : Identifiant de l’etat du contact email
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’etat du contact mobile
- SalutationID : Identifiant de la civilité
- SaleMgtID : Identifiant de l’entité gestionnaire
- CountryID : Identifiant du pays
- JoinDate : Date d’insertion du contact en base
- LeaveDate : Date de passage du contact en inactif
- Optin : Identifiant de l’origine du contact
- ProfileUpdateDate : Date de mise à jour du profil du contact
- LastOpenDate : Date de dernière ouverture du contact
- LastClickDate : Date de dernier clic du contact
- SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
|
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de parrainage | SponsorshipStatsList | SponsorshipStats[]
| Liste des statistiques de parrainage |
|
|
la classe hérite de : BaseMemberStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | Email | string | Adresse email | EventDistinct | int | Nombre d'évènements distincts | EventTotal | int | Nombre d'évènements total | SourceTypeID | int | Identifiant de l’origine
1 - Formulaire d'inscription
2 - Formulaire de désinscription
3 - Formulaire de modification de profil
4 - Formulaire jeux-concours
5 - Formulaire de parrainage
6 - Formulaire coupon-réponse
7 - WebService
8 - Page de confirmation d'inscription
9 - Formulaire questionnaires-enquêtes
10 - Campagne | SponsorshipID | int | Identifiant du parrainage |
- EventDate : Date de parrainage
- EventDistinct : Nombre de parrainage du parrain sur la campagne
- EventTotal : Nombre de parrains
|
GetCampaignStatsRequest |
la classe hérite de : BaseCampaignStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | GetChildList | boolean | (Facultatif) - Récupérer la liste des campagnes rattachées à une campagne mère |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- Sent : Nombre de message envoyés
- Canceled : Nombre de message annulés
- Delivered : Nombre de message identifiés en abouti
- HardBounce : Nombre de message identifiés en hardbounce
- Pending : Nombre de message non identifiés ou en diffusion
- Opened : Nombre de destinataires ayant ouverts au moins une fois
- OpenedOnce : Nombre de destinataires ayant ouverts une seule fois
- OpenedMultiple : Nombre de destinataires ayant ouvert plusieurs fois
- OpenedTotal : Nombre d’ouverture brut (ouvertures cumulées)
- Clicked : Nombre destinataires uniques ayant cliqués sur un lien
- ClickedNotTechnical : Nombre de destinataires uniques ayant cliqués sur au moins un lien non technique
- ClickedOnce : Nombre de destinataires uniques ayant cliqués une seule fois sur un lien non technique
- ClickedMultiple : Nombre de destinataires uniques ayant cliqués sur plusieurs liens non technique
- ClickedTotal : Nombre de destinataires ayant cliqués sur un un lien non technique
- Unsubscribed : Nombre de désabonnement
- Complaints : Nombre de plaintes
- GodFathers : Nombre de parrains
- Godsons : Nombre de filleuls
- ConvertedGodsons : Nombre de filleuls convertis
- IGQ : Valeur de l’IGQ
- NbLinks : Nombre de lien du message
- NbLinksNotTechnical : Nombre de lien non technique du message
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- Récupérer la liste des campagnes rattachées à une campagne mère.
|
GetCampaignStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de campagne | CampaignStatsList | CampaignStats[]
| Liste des statistiques de campagne |
|
CampaignStats |
la classe hérite de : BaseCampaignStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne |
Les valeurs possibles pour SendingType sont :
- 0 - Campagne classique
- 1 - Campagne de personnalisation dynamique "Mère"
- 2 - Campagne de personnalisation dynamique "Fille"
- 5 - Campagne de Trigger Marketing sur Segment "Fille"
- 6 - Campagne de Trigger Marketing sur Segment "Mère"
- 11 - Campagne d'A/B Testing - Finale
- 12 - Campagne d'A/B Testing - Test
- 13 - Campagne de Trigger Marketing sur Action
Les valeurs possibles pour CampaignStatus sont :
- 100 - Campagne en cours de création
- 200/300 - Campagne créée
- 10001 - Campagne planifiée
- 503 - Campagne en cours d'envoi
- 500 - Campagne terminée
- 301 - Demande d'annulation de la campagne
- 302 - Demande de pause de la campagne
- 303 - Demande de reprise de la campagne
- 501/505 - Campagne annulée
- 502 - Campagne en pause
- 505 - Campagne annulée
- 4XX/10002/10003 - Campagne refusée
|
BaseCampaignStats |
la classe hérite de : BaseStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne |
|
GetCampaignAggregatedStatsRequest |
la classe hérite de : BaseCampaignStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner | AggregatedType | AggregatedType | Type de regroupement des statistiques par heure (HOUR), par jour (DAY) ou par mois (MONTH)
| EventStartDate | string | Date de début de l'évènement | EventEndDate | string | Date de fin de l'évènement |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- Delivered : Nombre de message identifiés en abouti
- HardBounce : Nombre de message identifiés en hardbounce
- Opened : Nombre de message ouverts
- OpenedTotal : Nombre d’ouverture brut
- Clicked : Nombre de message cliqués
- ClickedNotTechnical : Nombre de destinataire unique ayant cliqué sur des liens non techniques
- ClickedTotal : Nombre de clics brut
- Unsubscribed : Nombre de désabonnement
- Complaints : Nombre de plaintes
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- Les paramètres EventStartDate (date incluse) et EventEndDate (date non incluse) correspondent à la date des évènements.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US. Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans.
- AggregatedType : En fonction du type de regroupement des statistiques (HOUR / DAY / MONTH), le champ EventAggregatedDate est retourné et correspond à la date agrégée pour chaque statistique. Le mois, le jour ou l'heure du champ EventAggregatedDate change d'un agrégat à l'autre.
|
GetCampaignAggregatedStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre des statistiques agrégées des campagnes | CampaignAggregatedStatsList | CampaignAggregatedStats[]
| Liste des statistiques agrégées |
|
CampaignAggregatedStats |
la classe hérite de : BaseCampaignStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | EventAggregatedDate | string | Date de la statistique agrégée |
Les valeurs possibles pour SendingType sont :
- 0 - Campagne classique
- 1 - Campagne de personnalisation dynamique "Mère"
- 2 - Campagne de personnalisation dynamique "Fille"
- 5 - Campagne de Trigger Marketing sur Segment "Fille"
- 6 - Campagne de Trigger Marketing sur Segment "Mère"
- 11 - Campagne d'A/B Testing - Finale
- 12 - Campagne d'A/B Testing - Test
- 13 - Campagne de Trigger Marketing sur Action
Les valeurs possibles pour CampaignStatus sont :
- 100 - Campagne en cours de création
- 200/300 - Campagne créée
- 10001 - Campagne planifiée
- 503 - Campagne en cours d'envoi
- 500 - Campagne terminée
- 301 - Demande d'annulation de la campagne
- 302 - Demande de pause de la campagne
- 303 - Demande de reprise de la campagne
- 501/505 - Campagne annulée
- 502 - Campagne en pause
- 505 - Campagne annulée
- 4XX/10002/10003 - Campagne refusée
- EventDate : Date d'envoi de la campagne
|
GetCampaignTrackingLinkStatsRequest |
la classe hérite de : BaseCampaignStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- LinkName : Nom du lien
- ThemeID : Identifiant du thème
- ThemeName : Description du thème
- ParentLinkID : Identifiant du lien parent
- DynamicComponentID : Identifiant du composant relié
- DynamicRuleID : Identifiant de la règle
- LinkRecipientDistinct : Nombre de destinataires distinct ayant cliqués sur le lien
- LinkClicksTotal : Nombre de clic brut sur le lien
- UrlRecipientDistinct : Nombre de destinataires distinct ayant cliqués sur l’url
- UrlClicksTotal : Nombre de clics brut sur l’url
- ThemeRecipientDistinct : Nombre de destinataires distinct ayant cliqués sur le thème
- ThemeClicksTotal : Nombre de clics brut sur le thème
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetCampaignTrackingLinkStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques des liens de tracking | CampaignTrackingLinkStatsList | CampaignTrackingLinkStats[]
| Liste des statistiques des liens de tracking |
|
CampaignTrackingLinkStats |
la classe hérite de : BaseCampaignStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | LinkID | int | Identifiant du lien | Url | string | Url du lien |
Les valeurs possibles pour SendingType sont :
- 0 - Campagne classique
- 1 - Campagne de personnalisation dynamique "Mère"
- 2 - Campagne de personnalisation dynamique "Fille"
- 5 - Campagne de Trigger Marketing sur Segment "Fille"
- 6 - Campagne de Trigger Marketing sur Segment "Mère"
- 11 - Campagne d'A/B Testing - Finale
- 12 - Campagne d'A/B Testing - Test
- 13 - Campagne de Trigger Marketing sur Action
Les valeurs possibles pour CampaignStatus sont :
- 100 - Campagne en cours de création
- 200/300 - Campagne créée
- 10001 - Campagne planifiée
- 503 - Campagne en cours d'envoi
- 500 - Campagne terminée
- 301 - Demande d'annulation de la campagne
- 302 - Demande de pause de la campagne
- 303 - Demande de reprise de la campagne
- 501/505 - Campagne annulée
- 502 - Campagne en pause
- 505 - Campagne annulée
- 4XX/10002/10003 - Campagne refusée
- EventDate : Date du clic sur le lien
|
GetCampaignSocialNetworkStatsRequest |
la classe hérite de : BaseCampaignStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- Total : Nombre de socionautes (données non disponible pour les BAT)
- Acquired : Nombre de socionautes acquis
- Existing : Nombre de socionautes de la base
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetCampaignSocialNetworkStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques globales des réseaux sociaux | CampaignSocialNetworkStatsList | CampaignSocialNetworkStats[]
| Liste des statistiques globales des réseaux sociaux |
|
CampaignSocialNetworkStats |
la classe hérite de : BaseCampaignStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne |
Les valeurs possibles pour SendingType sont :
- 0 - Campagne classique
- 1 - Campagne de personnalisation dynamique "Mère"
- 2 - Campagne de personnalisation dynamique "Fille"
- 5 - Campagne de Trigger Marketing sur Segment "Fille"
- 6 - Campagne de Trigger Marketing sur Segment "Mère"
- 11 - Campagne d'A/B Testing - Finale
- 12 - Campagne d'A/B Testing - Test
- 13 - Campagne de Trigger Marketing sur Action
Les valeurs possibles pour CampaignStatus sont :
- 100 - Campagne en cours de création
- 200/300 - Campagne créée
- 10001 - Campagne planifiée
- 503 - Campagne en cours d'envoi
- 500 - Campagne terminée
- 301 - Demande d'annulation de la campagne
- 302 - Demande de pause de la campagne
- 303 - Demande de reprise de la campagne
- 501/505 - Campagne annulée
- 502 - Campagne en pause
- 505 - Campagne annulée
- 4XX/10002/10003 - Campagne refusée
- EventDate : Date d'envoi de la campagne
|
GetCampaignSocialNetworkClickStatsRequest |
la classe hérite de : BaseCampaignStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- ClickedLinks : Nombre de liens cliqués
- Total : Nombre de destinataires ayant cliqué sur au moins un lien
- ClickedOnce : Nombre de destinataires ayant cliqué sur un seul lien
- ClickedMultiple : Nombre de destinataires ayant cliqué sur plusieurs liens
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetCampaignSocialNetworkClickStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de clic des réseaux sociaux | CampaignSocialNetworkClickStatsList | CampaignSocialNetworkClickStats[]
| Liste des statistiques des clics des réseaux sociaux |
|
CampaignSocialNetworkClickStats |
la classe hérite de : BaseCampaignStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | LinkType | int | Identifiant du type de lien (Suivi / Partage) | SocialNetworkID | int | Identifiant du réseau social (Facebook, Twitter, …) |
Les valeurs possibles pour SendingType sont :
- 0 - Campagne classique
- 1 - Campagne de personnalisation dynamique "Mère"
- 2 - Campagne de personnalisation dynamique "Fille"
- 5 - Campagne de Trigger Marketing sur Segment "Fille"
- 6 - Campagne de Trigger Marketing sur Segment "Mère"
- 11 - Campagne d'A/B Testing - Finale
- 12 - Campagne d'A/B Testing - Test
- 13 - Campagne de Trigger Marketing sur Action
Les valeurs possibles pour CampaignStatus sont :
- 100 - Campagne en cours de création
- 200/300 - Campagne créée
- 10001 - Campagne planifiée
- 503 - Campagne en cours d'envoi
- 500 - Campagne terminée
- 301 - Demande d'annulation de la campagne
- 302 - Demande de pause de la campagne
- 303 - Demande de reprise de la campagne
- 501/505 - Campagne annulée
- 502 - Campagne en pause
- 505 - Campagne annulée
- 4XX/10002/10003 - Campagne refusée
Les valeurs possibles pour SocialNetworkID sont :
- 1 - Facebook
- 2 - Twitter
- 3 - LinkedIn
- 4 - Viadeo
Les valeurs possibles pour LinkType sont :
- 1 - Lien de partage
- 2 - Lien de suivi
- EventDate : Date du clic sur le lien de réseaux sociaux
|
GetCampaignDomainStatsRequest |
la classe hérite de : BaseCampaignStatsRequest | ||
|
Champ | Type | Description |
---|
Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | CampaignIDList | int[]
| (Facultatif) - Liste d'identifiants de campagne | CampaignChildID | int | (Facultatif) - Numéro d'envoi | SegmentID | int | (Facultatif) - Identifiant du segment | StartDate | string | (Facultatif) - Date de début | EndDate | string | (Facultatif) - Date de fin | SaleMgtID | int | (Facultatif) - Identifiant de l'entité gestionnaire | StaticFieldList | string[]
| (Facultatif) - Liste des noms des champs statiques à retourner | SortField | string | (Facultatif) - Champ à trier par rapport aux champs retournés par la méthode | SortOrder | SortOrder | (Facultatif) - Ordre de tri (ASC / DESC) | Offset | int | (Facultatif) - Offset de lecture | Limit | int | (Facultatif) - Nombre maximum d'éléments à retourner |
- Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
Le format requis est DD/MM/YYYY (par défaut) et MM/DD/YYYY pour la culture "en-US". Les deux paramètres sont indissociables. La période de recherche ne doit pas dépasser 2 ans.
- Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
- Une campagne d'emailing est composée d'un identifiant - CampaignID - et d'une occurrence - CampaignChildID. Le paramètre CampaignChildID ne peut pas être renseigné seul. Il faut obligatoirement l'identifiant de la campagne. Il s'agit donc d'un couple CampaignID/CampaignChildID.
- Les valeurs possibles pour le champ StaticFieldList sont :
- Sent : NNombre de message envoyés
- Delivered : Nombre de message identifiés en abouti
- HardBounce : Nombre de message identifiés en hardbounce
- Pending : Nombre de message non identifiés ou en diffusion
- Spammed : Nombre de message identifié en spam temporaire
- Opened : Nombre de message ouverts
- ClickedNotTechnical : Nombre de message cliqués hors liens techniques
- Unsubscribed : Nombre de désabonnement
- Complaints : Nombre de plaintes
- Les valeurs possibles pour le champ SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
|
GetCampaignDomainStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de statistiques de domaine | CampaignDomainStatsList | CampaignDomainStats[]
| Liste des statistiques de domaine |
|
CampaignDomainStats |
la classe hérite de : BaseCampaignStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des noms des champs statiques à retourner | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | Domain | string | Domaine du contact |
Les valeurs possibles pour SendingType sont :
- 0 - Campagne classique
- 1 - Campagne de personnalisation dynamique "Mère"
- 2 - Campagne de personnalisation dynamique "Fille"
- 5 - Campagne de Trigger Marketing sur Segment "Fille"
- 6 - Campagne de Trigger Marketing sur Segment "Mère"
- 11 - Campagne d'A/B Testing - Finale
- 12 - Campagne d'A/B Testing - Test
- 13 - Campagne de Trigger Marketing sur Action
Les valeurs possibles pour CampaignStatus sont :
- 100 - Campagne en cours de création
- 200/300 - Campagne créée
- 10001 - Campagne planifiée
- 503 - Campagne en cours d'envoi
- 500 - Campagne terminée
- 301 - Demande d'annulation de la campagne
- 302 - Demande de pause de la campagne
- 303 - Demande de reprise de la campagne
- 501/505 - Campagne annulée
- 502 - Campagne en pause
- 505 - Campagne annulée
- 4XX/10002/10003 - Campagne refusée
- EventDate : Date d'envoi de la campagne
|
ServiceException |
|
Champ | Type | Description |
---|
Ticket | string | Le numéro de ticket | Message | string | Le message d'erreur | Description | string | La description de l'erreur | ErrorCodeType | ErrorCodeType | Type du code de l'erreur | ErrorCode | int | Code de l'erreur |
|
ValidationFault |
|
Champ | Type | Description |
---|
Details | ValidationDetail[]
| Liste des détails de l'erreur de validation de la requête |
|
ValidationDetail |
|
Champ | Type | Description |
---|
Key | string | Nom du champ à valider | Message | string | Résultat de la validation | Tag | string | Tag de validation |
|
Liste des erreurs communes |
|
Code | Nom | Description |
---|
0 | UnexpectedException | Erreur inattendue | 1 | AuthenticationException | Erreur d'authentification | 2 | NullTokenException | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | 3 | NullRequestException | L'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée | 5 | InvalidArgumentException | Les arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité | 6 | BadRequestException | La requête n'est pas correcte | 7 | NothingToDoException | La requête demandée n'effectue aucun traitement, car les données soient déjà à jour, il est possible que la requête ai été exécuté plusieurs fois | 8 | InvalidDataTypeException | Le type de donnée n'est pas valide | 9 | UnknownTicketException | Le ticket n'est pas connu, vérifiez la valeur de celui-ci | 10 | UnavailableTicketResultException | Le résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard. | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | 999998 | TokenNull | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | 999999 | TokenNotAuthorized | L'objet 'token' n'est pas autorisé, vérifiez les propriétés |
|