Service de statistiques du webtracking |
|
DéfinitionLe service de statistiques du webtracking 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, commandes, acheteurs et les donénes relatives aux visites..
|
Principe fonctionnementVoici quelques règles de fonctionnement pour utiliser au mieux nos API de statistiques de webtracking.
- 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.
- 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.
|
Synthèse des statistiques de webtracking des campagnesNom de la méthode : GetCampaignsSummaryStatsCette méthode vous permet de récupérer une synthèse des statistiques de webtracking des campagnes tels que le nombre de visite et visiteur, des temps moyens de visite et de consultation de page ou des taux de conversion et de rebond sur chacune des campagnes de la période ou de la liste de recherche.
|
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 |
|
|
Synthèse d’audience des supports de consultationNom de la méthode : GetDevicesSummaryStatsCette méthode vous permet de récupérer une synthèse d’audience des supports de consultation sur chacune des campagnes de la période ou de la liste de recherche.
|
Les paramètres attendus en entrée |
|
Les valeurs renvoyées |
Type | Description |
---|
GetDevicesSummaryStatsResult | Objet contenant la liste des synthèses d’audience des supports de consultation pour une liste de campagne |
|
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 |
|
|
Synthèse d’audience des navigateurs utilisésNom de la méthode : GetBrowsersSummaryStatsCette méthode vous permet de récupérer une synthèse d’audience des navigateurs utilisés sur chacune des campagnes de la période ou de la liste de recherche.
|
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 |
|
|
Nom de la méthode : GetOrdersSummaryStatsCette méthode vous permet de récupérer une synthèse des commandes tels que les nombres de transactions, le chiffre d 'affaires et le panier moyen sur chacune des campagnes de la période ou de la liste de recherche.
|
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 | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée |
|
|
Synthèse des produits commandésNom de la méthode : GetOrderedProductsSummaryStatsCette méthode vous permet de récupérer une synthèse des produits commandés sur chacune des campagnes de la période ou de la liste de recherche.
|
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 | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée |
|
|
Nom de la méthode : GetBuyersSummaryStatsCette méthode vous permet de récupérer une synthèse des acheteurs sur chacune des campagnes de la période ou de la liste de recherche.
|
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 | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée |
|
|
Synthèse des pages d'entréesNom de la méthode : GetEntryPagesSummaryStatsCette méthode vous permet de récupérer une synthèse des pages d'entrées sur chacune des campagnes de la période ou de la liste de recherche.
|
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 | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée |
|
|
Synthèse des pages visitéesNom de la méthode : GetViewedPagesSummaryStatsCette méthode vous permet de récupérer une synthèse des pages visitées sur chacune des campagnes de la période ou de la liste de recherche.
|
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 | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée |
|
|
Les objets du service de statistiques du webtracking |
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 |
|
GetCampaignsSummaryStatsRequest |
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter |
- 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- CountVisit : Nombre de visite
- CountVisitor : Nombre de visiteur
- ConversionRate : Taux de conversion
- AvgPageDuration : Temps moyen de consultation des pages (en millisecondes)
- AvgVisitDuration : Temps moyen de visite d'un site (en millisecondes)
- AvgPageCountByVisit : Nombre moyen de page consultée par visite
- CountVisitor1Visit : Nombre de contact par visite
- BoundingRate : Taux de rebond
- CountNewVisitor : Nombre de nouveau visteur
- NewVisitorRate : Taux de nouveau visiteur
|
BaseWebtrackingSummaryStatsRequest |
la classe hérite de : BaseWebtrackingStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter |
|
BaseWebtrackingStatsRequest |
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 |
|
GetCampaignsSummaryStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de campagne | CampaignSummaryStatsList | CampaignSummaryStats[]
| Liste des synthèses de statistiques de campagne |
|
CampaignSummaryStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs |
- 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
|
BaseWebTrackingStats |
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs |
|
StaticFieldValue |
|
Champ | Type | Description |
---|
Name | string | Nom système du champ retourné | Value | string | Valeur du champ |
|
GetDevicesSummaryStatsRequest |
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter |
- 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- Count : Nombre d'utilisateur du support de consultation
- Rate : Pourcentage de répartition du support
|
GetDevicesSummaryStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de support de consultation pour la liste de campagnes choisies | DeviceSummaryStatsList | DeviceSummaryStats[]
| Liste des synthèses d’audience des supports de consultation pour une liste de campagne |
|
DeviceSummaryStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | DeviceID | int | Identifiant du support de consultation | DeviceCategory | string | Catégorie du support de consultation |
- EventDate : Date d'envoi de la campagne
|
|
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter |
- 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- Count : Nombre d'utilisateur du navigateur
- Rate : Pourcentage de répartition du navigateur
|
|
|
Champ | Type | Description |
---|
Count | int | Nombre de navigateur pour la liste de campagnes choisies | BrowserSummaryStatList | BrowserSummaryStats[]
| Liste des synthèses d'audience des navigateurs utilisés pour une liste de campagne |
|
BrowserSummaryStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | BrowserID | int | Identifiant du navigateur | BrowserName | string | Nom du navigateur |
- EventDate : Date d'envoi de la campagne
|
|
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter | Currency | string | Code de la devise de la commande. Par exemple (USD ou EUR). |
- 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- CountProduct : Nombre total de produit commandé par campagne
- CountOrder : Nombre de commandes
- Amount : Chiffre d'affaires
- Shipping : Montant des frais de livraison
- Tax : Montant des taxes
- AvgAmount : Panier moyen
|
|
|
Champ | Type | Description |
---|
Count | int | Nombre de commandes retournées | OrderSummaryStatsList | OrderSummaryStats[]
| Liste des synthèses de commande de la liste des campagnes |
|
OrderSummaryStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | Currency | string | Code de la devise de la commande. Par exemple (USD ou EUR). |
- EventDate : Date d'envoi de la campagne
|
GetOrderedProductsSummaryStatsRequest |
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter | Currency | string | (Facultatif) Code de la devise du produit. Par exemple (USD ou EUR). |
- 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- CountProduct : Nombre total de produit commandé par campagne
- Amount: Montant total du produit commandé par campagne
- Currency: Code de la devise du produit
|
GetOrderedProductsSummaryStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de produits retournés | OrderedProductSummaryStatsList | OrderedProductSummaryStats[]
| Liste des synthèses de produit pour les commandes de la liste des campagnes |
|
OrderedProductSummaryStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | ProductCode | string | Code produit | ProductName | string | Nom du produit |
- EventDate : Date d'envoi de la campagne
|
|
la classe hérite de : BaseWebtrackingMemberStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter | 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- Amount : Montant total des commandes passées
- CustomFieldIDList : Identifiant des champs personnalisés du contact. Disponible à partir de l'API de gestion des champs de la base.
|
BaseWebtrackingMemberStatsRequest |
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter | CustomFieldIDList | int[]
| (Facultatif) - Liste d'identifiants de champs personnalisés à retourner |
|
|
|
Champ | Type | Description |
---|
Count | int | Nombre d'acheteur pour la liste des campagnes données | BuyerSummaryStatsList | BuyerSummaryStats[]
| Liste des acheteurs de la liste des campagnes |
|
BuyerSummaryStats |
la classe hérite de : BaseMemberWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs personnalisés ainsi que leurs valeurs | Email | string | Adresse email de l'acheteur | Currency | string | Code de la devise de la commande. Par exemple (USD ou EUR). |
- EventDate : Date d'envoi de la campagne
|
BaseMemberWebTrackingStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | CustomFieldValueList | CustomFieldValue[]
| (Facultatif) - Liste des noms des champs personnalisés ainsi que leurs valeurs | Email | string | Adresse email de l'acheteur |
|
CustomFieldValue |
|
Champ | Type | Description |
---|
ID | int | Identifiant du champ | Value | string | Valeur du champ |
|
GetEntryPagesSummaryStatsRequest |
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter |
- 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- CountVisit : Nombre de visiteur
- CountBounding : Nombre de fois que la page est à la fois entrée et sortie
- BoundingRate : Taux de rebond
|
GetEntryPagesSummaryStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de pages d'entrées pour la liste des campagnes données | EntryPageSummaryStatsList | EntryPageSummaryStats[]
| Liste des synthèses des pages d'entrées de la liste des campagnes |
|
EntryPageSummaryStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | PageUrl | string | Url de la page | PageTitle | string | Titre de la page |
- EventDate : Date d'envoi de la campagne
|
GetViewedPagesSummaryStatsRequest |
la classe hérite de : BaseWebtrackingSummaryStatsRequest | ||
|
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 | SiteIDList | int[]
| (Facultatif) - Liste d'identifiants des sites à traiter |
- 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. - 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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.
- 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.
- Les valeurs possibles pour le champ StaticFieldList sont :
- CountVisit : Nombre de visiteur
- AvgVisitDuration : Temps moyen de visite de la page (en millisecondes)
- CountEndPage : Nombre de fois que la page a été vu en dernier
- EndingRate : Taux de sortie
|
GetViewedPagesSummaryStatsResult |
|
Champ | Type | Description |
---|
Count | int | Nombre de pages visitées pour la liste des campagnes données | ViewedPageSummaryStatsList | ViewedPageSummaryStats[]
| Liste des synthèses des pages visitées de la liste des campagnes |
|
ViewedPageSummaryStats |
la classe hérite de : BaseWebTrackingStats | ||
|
Champ | Type | Description |
---|
CampaignID | int | Numéro de campagne | CampaignChildID | int | Numéro d'envoi | EventDate | string | Date de l'évènement | TestMode | boolean | Campagne en mode test (0/1) | SendingType | int | Type d'envoi | CampaignStatus | int | Status de la campagne | StaticFieldValueList | StaticFieldValue[]
| (Facultatif) - Liste des champs statiques avec leurs valeurs | PageUrl | string | Url de la page | PageTitle | string | Titre de la page |
- 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 |
|