Service de statistiques

Contrat WSDL	http://apitmapreprod.dolist.net/v3/StatisticsService.svc?Wsdl
Exemple disponible	Implémentation en .NET C# 4.0 Implémentation en JSON. Implémentation en JAVA.

Définition

Le service de statistiques des compaigne SMS vous permet de récupérer les contacts aboutis, non aboutis et les désabonnés sur une (ou plusieurs) campagne(s) donnée(s) ou sur une période définie.
En fonction de la fréquence que vous aurez choisi, vous pourrez recevoir, par e-mail, le rapport de statistiques de votre campagne au format CSV ou PDF.

Statistiques sur la réception d'une compagne SMS

Nom de la méthode : GetDeliverySMSStats

Cette méthode vous permet de récupérer les informations relatives aux contacts qui ont reçu le message des campagnes de la période ou de la liste de recherche.

Les paramètres attendus en entrée

Champ	Type	Description
authenticationTokenContext	`AuthenticationTokenContext`	Jeton d'authentification
request	`GetDeliverySMSStatsRequest`	Paramètres de la requête

Les valeurs renvoyées

Type	Description
`GetDeliverySMSStatsResult`	Objet contenant la liste des statistiques de réception d'une compagne SMS 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
11	`InvalidDatePeriodException`	L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête

Statistiques sur les hardbounce d'une compagne SMS

Nom de la méthode : GetHardbounceSMSStats

Cette méthode vous permet de récupérer les informations relatives aux contacts non aboutis (Hardbounce) des campagnes de la période ou de la liste de recherche.

Les paramètres attendus en entrée

Champ	Type	Description
authenticationTokenContext	`AuthenticationTokenContext`	Jeton d'authentification
request	`GetHardbounceSMSStatsRequest`	Paramètres de la requête

Les valeurs renvoyées

Type	Description
`GetHardbounceSMSStatsResult`	Objet contenant la liste des statistiques de hardbounce d'une compagne SMS 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
11	`InvalidDatePeriodException`	L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête

Statistiques sur les désabonnements d'une compagne SMS

Nom de la méthode : GetUnsubscribeSMSStats

Cette méthode vous permet de récupérer les informations relatives aux contacts désabonnés des campagnes de la période ou de la liste de recherche.

Les paramètres attendus en entrée

Champ	Type	Description
authenticationTokenContext	`AuthenticationTokenContext`	Jeton d'authentification
request	`GetUnsubscribeSMSStatsRequest`	Paramètres de la requête

Les valeurs renvoyées

Type	Description
`GetUnsubscribeSMSStatsResult`	Objet contenant la liste des statistiques des désabonnements d'une compagne SMS 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
11	`InvalidDatePeriodException`	L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête

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

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

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

GetDeliverySMSStatsRequest

la classe hérite de : BaseMemberSMSStatsRequest

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
StartDate	`string`	(Facultatif) - Date de début
EndDate	`string`	(Facultatif) - Date de fin
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.
Les valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’état du contact mobile
- SalutationID : Identifiant de la civilité
- 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
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.

BaseMemberSMSStatsRequest

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
StartDate	`string`	(Facultatif) - Date de début
EndDate	`string`	(Facultatif) - Date de fin
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

GetDeliverySMSStatsResult

Champ	Type	Description
Count	`int`	Nombre de statistiques de réception d'une compagne SMS
DeliveryStatsList	`DeliverySMSStats[]`	Liste des statistiques de réception d'une compagne SMS

DeliverySMSStats

la classe hérite de : BaseMemberSMSStats

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
Mobile	`string`	Numéro Mobile

BaseMemberSMSStats

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
Mobile	`string`	Numéro Mobile

GetHardbounceSMSStatsRequest

la classe hérite de : BaseMemberSMSStatsRequest

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
StartDate	`string`	(Facultatif) - Date de début
EndDate	`string`	(Facultatif) - Date de fin
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 valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’état du contact mobile
- SalutationID : Identifiant de la civilité
- 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
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 SortField sont celles passées dans StaticFieldList et les propriétés de l'objet retournée pour les statistiques.

GetHardbounceSMSStatsResult

Champ	Type	Description
Count	`int`	Nombre de statistiques de hardbounce d'une compagne SMS
HardbounceStatsList	`HardbounceSMSStats[]`	Liste des statistiques de hardbounce d'une compagne SMS

HardbounceSMSStats

la classe hérite de : BaseMemberSMSStats

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
Mobile	`string`	Numéro Mobile

GetUnsubscribeSMSStatsRequest

la classe hérite de : BaseMemberSMSStatsRequest

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
StartDate	`string`	(Facultatif) - Date de début
EndDate	`string`	(Facultatif) - Date de fin
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 valeurs possibles pour le champ StaticFieldList sont :
- MemberID : Identifiant du contact
- Mobile : Numéro de téléphone Mobile
- OptoutMobile : Identifiant de l’état du contact mobile
- SalutationID : Identifiant de la civilité
- 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
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.

GetUnsubscribeSMSStatsResult

Champ	Type	Description
Count	`int`	Nombre de statistiques de désabonnement d'une compagne SMS
UnsubscribeStatsList	`UnsubscribeSMSStats[]`	Liste des statistiques de désabonnement d'une compagne SMS

UnsubscribeSMSStats

la classe hérite de : BaseMemberSMSStats

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
Mobile	`string`	Numéro Mobile

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