Service des statistiques comportementales d'un contact

Contrat WSDL	http://apitmapreprod.dolist.net/v2/ContactStatisticService.svc?wsdl
Exemple disponible	Implémentation en PHP.

Définition

Le service de gestion des statistiques comportementales d'un contact va vous permettre de récupérer l'ensemble des informations personnelles et comportementales liées au contact.

Récupération des informations d'un contact pour les X dernières campagnes

Nom de la méthode : RequestContact

Cette méthode va vous permettre de récupérer les informations du contact et ses statistiques comportementales pour les X dernières campagnes envoyées.
X correspond au champ "nbCampaignRecentlySent" défini ci-dessous.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Jeton d'authentification
email	`string`	Email du contact
allFields	`boolean`	Récupérer tous les champs du contact
allInterests	`boolean`	Récupérer tous les intérêts déclarés du contact
nbCampaignRecentlySent	`int`	Nombre de campagnes dernièrement envoyées au contact

Les valeurs renvoyées

Type	Description
`string`	Renvoie le ticket de la demande

Récupération des informations d'un contact pour des campagnes données

Nom de la méthode : RequestContactWithSpecificCampaigns

Cette méthode va vous permettre de récupérer les informations du contact et ses statistiques comportementales pour des campagnes données.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Jeton d'authentification
email	`string`	Email du contact
allFields	`boolean`	Récupérer tous les champs du contact
allInterests	`boolean`	Récupérer tous les intérêts déclarés du contact
campaignsId	`int[]`	Liste des campagnes à retourner

Les valeurs renvoyées

Type	Description
`string`	Renvoie le ticket de la demande

Récupération des informations d'un contact pour les X dernières campagnes (Pagination)

Nom de la méthode : RequestContactNextCampaign

Cette méthode va vous permettre de récupérer les informations du contact et ses statistiques comportementales pour les X dernières campagnes envoyées depuis la campagne "lastCampaignId"

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Jeton d'authentification
email	`string`	Email du contact
nbCampaignRecentlySent	`int`	Récupérer les x dernières campagnes envoyées au contact
lastCampaignId	`int`	Identifiant de la dernière campagne récupérée

Les valeurs renvoyées

Type	Description
`string`	Demande de récupération des infos des campagnes suivantes d'un contact

Nom de la méthode : GetContactByTicket

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Jeton d'authentification
ticket	`string`	Ticket de la demande

Les valeurs renvoyées

Type	Description
`Response`	Renvoie les informations du contact

Les objets du service des statistiques comportementales d'un contact

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

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

Response

Résultat de votre demande d'information d'un contact.

Champ	Type	Description
Contact	`Contact`	Contact
Description	`string`	Description du statut de la demande
Status	`int`	Statut de la demande

Liste des statuts possibles :

0 : Traitement en cours
1 : Traitement terminé
2 : Numéro du ticket inconnu

Contact

Informations du contact.

Champ	Type	Description
Campaigns	`Campaign[]`	Liste des campagnes du contact
Email	`string`	Email du contact
Fields	`Field[]`	Liste des champs du contact
Interests	`Interest[]`	Liste des intérêts déclarés du contact
MemberId	`int`	Identifiant du contact
NbCampaigns	`int`	Nombre de campagnes envoyées au contact
OptoutEmail	`int`	Optout email du contact
OptoutMobile	`int`	Optout sms du contact
SubscribeDate	`dateTime`	Date d'inscription du contact
UnsubscribeDate	`dateTime`	Date de désabonnement du contact
UpdateDate	`dateTime`	Date de modification du contact

Campaign

Champ	Type	Description
Archived	`boolean`	Campagne archivée
CampaignDate	`dateTime`	Date de la campagne
Id	`int`	Identifiant de la campagne
Message	`Message`	Message de la campagne
Planning	`Planning`	Planning de la campagne
Segment	`Segment`	Segment de la campagne
Statistics	`Statistics`	Statistiques de la campagne
Subject	`string`	Sujet de la campagne
Type	`int`	Type de la campagne

Message

Champ	Type	Description
Id	`int`	Identifiant du message
Name	`string`	Nom du message

Planning

Champ	Type	Description
Id	`int`	Identifiant du planning de la campagne
SendDate	`dateTime`	Date d'envoi de la campagne

Segment

Champ	Type	Description
Id	`int`	Identifiant du segment de la campagne
Name	`string`	Nom du segment de la campagne

Statistics

Champ	Type	Description
Click	`StatisticsClick`	Statistiques de clics de la campagne
LinkClick	`StatisticsLink[]`	Liste des liens cliqués de la campagne
Open	`StatisticsOpen`	Statistiques d'ouvertures de la campagne
WebtrackingMember	`Webtracking`	Statistiques de webtracking de la campagne

StatisticsClick

Statistiques de clics du contact sur la campagne.

Champ	Type	Description
DatesClick	`dateTime[]`	Dates de clics sur la campagne
Nb	`int`	Nombre de clics sur la campagne

StatisticsLink

Statistiques du contact sur un lien de la campagne.

Champ	Type	Description
DatesClick	`dateTime[]`	Dates de clics sur le lien
LinkName	`string`	Nom du lien cliqué
NbClick	`int`	Nombre de clics du lien cliqué
ThematicName	`string`	Nom du thème du lien cliqué
Url	`string`	Url du lien cliqué

StatisticsOpen

Champ	Type	Description
DatesOpen	`dateTime[]`	Dates d'ouvertures sur la campagne
Nb	`int`	Nombre d'ouvertures sur la campagne

Webtracking

Webtracking du contact à partir de la campagne.

Champ	Type	Description
CartAmount	`double`	Chiffre d'affaire généré sur la campagne
NbViewPage	`int`	Nombre de pages vues à partir de la campagne

Field

Champ	Type	Description
CustomName	`string`	Nom personnalisé du champ
FieldType	`int`	Type de champ: 1-chaine de caractères, 2-entier, 3-date, 4-civilité, 5-format de message, 6-interet déclaré, 7-entitté gestionnaire, 8-pays, 9-html, 10-url
ID	`int`	Identifiant du champ
Name	`string`	Nom du champ
Value	`string`	Valeur du champ

Les valeurs possibles pour "FieldType" sont :

1 : Chaine de caractères
2 : Entier
3 : Date
4 : Civilité
5 : Format de message
6 : Intérêt déclaré
7 : Entité gestionnaire
8 : Pays
9 : HTML
10 : Url

Interest

Valeur de l'intérêt déclaré du contact et sa date d'inscription à l'intérêt déclaré.

Champ	Type	Description
Group	`InterestGroup`	Groupe d'intérêt déclaré
InterestDate	`dateTime`	Date d'inscription à l'intérêt déclaré
Value	`InterestValue`	Intérêt déclaré

InterestGroup

Groupe d'intérêt déclaré.

Champ	Type	Description
Id	`int`	Identifiant du groupe d'intérêt déclaré
Name	`string`	Nom du groupe d'intérêt déclaré

InterestValue

Intérêt déclaré.

Champ	Type	Description
Id	`int`	Identifiant de l'intérêt déclaré
Name	`string`	Nom de l'intérêt déclaré

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