Service des statistiques comportementales d'un contact
Contrat WSDLhttp://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
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    emailstringEmail du contact
    allFieldsbooleanRécupérer tous les champs du contact
    allInterestsbooleanRécupérer tous les intérêts déclarés du contact
    nbCampaignRecentlySentintNombre de campagnes dernièrement envoyées au contact
    Les valeurs renvoyées
    TypeDescription
    stringRenvoie 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
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    emailstringEmail du contact
    allFieldsbooleanRécupérer tous les champs du contact
    allInterestsbooleanRécupérer tous les intérêts déclarés du contact
    campaignsIdint[] Liste des campagnes à retourner
    Les valeurs renvoyées
    TypeDescription
    stringRenvoie 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
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    emailstringEmail du contact
    nbCampaignRecentlySentintRécupérer les x dernières campagnes envoyées au contact
    lastCampaignIdintIdentifiant de la dernière campagne récupérée
    Les valeurs renvoyées
    TypeDescription
    stringDemande 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
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    ticketstringTicket de la demande
    Les valeurs renvoyées
    TypeDescription
    ResponseRenvoie les informations du contact

    Les objets du service des statistiques comportementales d'un contact

    AuthenticationTokenContext

    ChampTypeDescription
    AccountIDintIdentifiant du client
    KeystringClé du jeton d'authentification
    ListIDintIdentifiant du client: obsolète. Utilisez AccountID à la place

      ServiceException

      ChampTypeDescription
      TicketstringLe numéro de ticket
      MessagestringLe message d'erreur
      DescriptionstringLa description de l'erreur
      ErrorCodeTypeErrorCodeTypeType du code de l'erreur
      ErrorCodeintCode de l'erreur

        ValidationFault

        ChampTypeDescription
        DetailsValidationDetail[] Liste des détails de l'erreur de validation de la requête

          ValidationDetail

          ChampTypeDescription
          KeystringNom du champ à valider
          MessagestringRésultat de la validation
          TagstringTag de validation

            Response

            Résultat de votre demande d'information d'un contact.
            ChampTypeDescription
            ContactContactContact
            DescriptionstringDescription du statut de la demande
            StatusintStatut de la demande

            Liste des statuts possibles :
            • 0 : Traitement en cours
            • 1 : Traitement terminé
            • 2 : Numéro du ticket inconnu

            Contact

            Informations du contact.
            ChampTypeDescription
            CampaignsCampaign[] Liste des campagnes du contact
            EmailstringEmail du contact
            FieldsField[] Liste des champs du contact
            InterestsInterest[] Liste des intérêts déclarés du contact
            MemberIdintIdentifiant du contact
            NbCampaignsintNombre de campagnes envoyées au contact
            OptoutEmailintOptout email du contact
            OptoutMobileintOptout sms du contact
            SubscribeDatedateTimeDate d'inscription du contact
            UnsubscribeDatedateTimeDate de désabonnement du contact
            UpdateDatedateTimeDate de modification du contact

              Campaign

              ChampTypeDescription
              ArchivedbooleanCampagne archivée
              CampaignDatedateTimeDate de la campagne
              IdintIdentifiant de la campagne
              MessageMessageMessage de la campagne
              PlanningPlanningPlanning de la campagne
              SegmentSegmentSegment de la campagne
              StatisticsStatisticsStatistiques de la campagne
              SubjectstringSujet de la campagne
              TypeintType de la campagne

                Message

                ChampTypeDescription
                IdintIdentifiant du message
                NamestringNom du message

                  Planning

                  ChampTypeDescription
                  IdintIdentifiant du planning de la campagne
                  SendDatedateTimeDate d'envoi de la campagne

                    Segment

                    ChampTypeDescription
                    IdintIdentifiant du segment de la campagne
                    NamestringNom du segment de la campagne

                      Statistics

                      ChampTypeDescription
                      ClickStatisticsClickStatistiques de clics de la campagne
                      LinkClickStatisticsLink[] Liste des liens cliqués de la campagne
                      OpenStatisticsOpenStatistiques d'ouvertures de la campagne
                      WebtrackingMemberWebtrackingStatistiques de webtracking de la campagne

                        StatisticsClick

                        Statistiques de clics du contact sur la campagne.
                        ChampTypeDescription
                        DatesClickdateTime[] Dates de clics sur la campagne
                        NbintNombre de clics sur la campagne

                          StatisticsLink

                          Statistiques du contact sur un lien de la campagne.
                          ChampTypeDescription
                          DatesClickdateTime[] Dates de clics sur le lien
                          LinkNamestringNom du lien cliqué
                          NbClickintNombre de clics du lien cliqué
                          ThematicNamestringNom du thème du lien cliqué
                          UrlstringUrl du lien cliqué

                            StatisticsOpen

                            ChampTypeDescription
                            DatesOpendateTime[] Dates d'ouvertures sur la campagne
                            NbintNombre d'ouvertures sur la campagne

                              Webtracking

                              Webtracking du contact à partir de la campagne.
                              ChampTypeDescription
                              CartAmountdoubleChiffre d'affaire généré sur la campagne
                              NbViewPageintNombre de pages vues à partir de la campagne

                                Field

                                ChampTypeDescription
                                CustomNamestringNom personnalisé du champ
                                FieldTypeintType 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
                                IDintIdentifiant du champ
                                NamestringNom du champ
                                ValuestringValeur 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é.
                                ChampTypeDescription
                                GroupInterestGroupGroupe d'intérêt déclaré
                                InterestDatedateTimeDate d'inscription à l'intérêt déclaré
                                ValueInterestValueIntérêt déclaré

                                  InterestGroup

                                  Groupe d'intérêt déclaré.
                                  ChampTypeDescription
                                  IdintIdentifiant du groupe d'intérêt déclaré
                                  NamestringNom du groupe d'intérêt déclaré

                                    InterestValue

                                    Intérêt déclaré.
                                    ChampTypeDescription
                                    IdintIdentifiant de l'intérêt déclaré
                                    NamestringNom de l'intérêt déclaré

                                      Liste des erreurs communes

                                      CodeNomDescription
                                      0UnexpectedExceptionErreur inattendue
                                      1AuthenticationExceptionErreur d'authentification
                                      2NullTokenExceptionLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
                                      3NullRequestExceptionL'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
                                      4ForbiddenActionExceptionL'action demandée n'est pas autorisée
                                      5InvalidArgumentExceptionLes arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité
                                      6BadRequestExceptionLa requête n'est pas correcte
                                      7NothingToDoExceptionLa 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
                                      8InvalidDataTypeExceptionLe type de donnée n'est pas valide
                                      9UnknownTicketExceptionLe ticket n'est pas connu, vérifiez la valeur de celui-ci
                                      10UnavailableTicketResultExceptionLe résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard.
                                      11InvalidDatePeriodExceptionL'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête
                                      999998TokenNullLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
                                      999999TokenNotAuthorizedL'objet 'token' n'est pas autorisé, vérifiez les propriétés