Service de statistiques
Contrat WSDLhttp://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
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetDeliverySMSStatsRequestParamètres de la requête
    Les valeurs renvoyées
    TypeDescription
    GetDeliverySMSStatsResultObjet contenant la liste des statistiques de réception d'une compagne SMS ainsi que leur nombre
    Liste des erreurs possibles
    Erreurs communes
    CodeNomDescription
    107SegmentNotFoundExceptionLe segment demandé n'existe pas
    409SaleManagerNotFoundExceptionL'entité gestionnaire demandée n'existe pas
    503InvalidStatsFilterExceptionVous devez donner une liste d'identifiants de campagne ou une période
    504InvalidSortFieldExceptionLe champ de tri spécifié n'est pas disponible
    920TooLongPeriodExceptionPériode de recherche de la campagne dépassée
    11InvalidDatePeriodExceptionL'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
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetHardbounceSMSStatsRequestParamètres de la requête
    Les valeurs renvoyées
    TypeDescription
    GetHardbounceSMSStatsResultObjet contenant la liste des statistiques de hardbounce d'une compagne SMS ainsi que leur nombre
    Liste des erreurs possibles
    Erreurs communes
    CodeNomDescription
    107SegmentNotFoundExceptionLe segment demandé n'existe pas
    409SaleManagerNotFoundExceptionL'entité gestionnaire demandée n'existe pas
    503InvalidStatsFilterExceptionVous devez donner une liste d'identifiants de campagne ou une période
    504InvalidSortFieldExceptionLe champ de tri spécifié n'est pas disponible
    920TooLongPeriodExceptionPériode de recherche de la campagne dépassée
    11InvalidDatePeriodExceptionL'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
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetUnsubscribeSMSStatsRequestParamètres de la requête
    Les valeurs renvoyées
    TypeDescription
    GetUnsubscribeSMSStatsResultObjet contenant la liste des statistiques des désabonnements d'une compagne SMS ainsi que leur nombre
    Liste des erreurs possibles
    Erreurs communes
    CodeNomDescription
    107SegmentNotFoundExceptionLe segment demandé n'existe pas
    409SaleManagerNotFoundExceptionL'entité gestionnaire demandée n'existe pas
    503InvalidStatsFilterExceptionVous devez donner une liste d'identifiants de campagne ou une période
    504InvalidSortFieldExceptionLe champ de tri spécifié n'est pas disponible
    920TooLongPeriodExceptionPériode de recherche de la campagne dépassée
    11InvalidDatePeriodExceptionL'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête

    Les objets du service de statistiques

    AuthenticationTokenContext

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

      BaseServiceRequest

      ChampTypeDescription
      Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
      UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur

        StaticFieldValue

        ChampTypeDescription
        NamestringNom système du champ retourné
        ValuestringValeur du champ

          CustomFieldValue

          ChampTypeDescription
          IDintIdentifiant du champ
          ValuestringValeur du champ

            GetDeliverySMSStatsRequest

            la classe hérite de : BaseMemberSMSStatsRequest
            ChampTypeDescription
            Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
            UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur
            CampaignIDListint[] (Facultatif) - Liste d'identifiants de campagne
            StartDatestring(Facultatif) - Date de début
            EndDatestring(Facultatif) - Date de fin
            StaticFieldListstring[] (Facultatif) - Liste des noms des champs statiques à retourner
            SortFieldstring(Facultatif) - Champ à trier par rapport aux champs retournés par la méthode
            SortOrderSortOrder(Facultatif) - Ordre de tri (ASC / DESC)
            Offsetint(Facultatif) - Offset de lecture
            Limitint(Facultatif) - Nombre maximum d'éléments à retourner
            CustomFieldIDListint[] (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
            ChampTypeDescription
            Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
            UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur
            CampaignIDListint[] (Facultatif) - Liste d'identifiants de campagne
            StartDatestring(Facultatif) - Date de début
            EndDatestring(Facultatif) - Date de fin
            StaticFieldListstring[] (Facultatif) - Liste des noms des champs statiques à retourner
            SortFieldstring(Facultatif) - Champ à trier par rapport aux champs retournés par la méthode
            SortOrderSortOrder(Facultatif) - Ordre de tri (ASC / DESC)
            Offsetint(Facultatif) - Offset de lecture
            Limitint(Facultatif) - Nombre maximum d'éléments à retourner
            CustomFieldIDListint[] (Facultatif) - Liste d'identifiants de champs personnalisés à retourner

              GetDeliverySMSStatsResult

              ChampTypeDescription
              CountintNombre de statistiques de réception d'une compagne SMS
              DeliveryStatsListDeliverySMSStats[] Liste des statistiques de réception d'une compagne SMS

                DeliverySMSStats

                la classe hérite de : BaseMemberSMSStats
                ChampTypeDescription
                CampaignIDintNuméro de campagne
                CampaignChildIDintNuméro d'envoi
                EventDatestringDate de l'évènement
                StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                CustomFieldValueListCustomFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                EmailstringAdresse email
                EventDistinctintNombre d'évènements distincts
                EventTotalintNombre d'évènements total
                MobilestringNuméro Mobile

                  BaseMemberSMSStats

                  la classe hérite de : BaseMemberStats
                  ChampTypeDescription
                  CampaignIDintNuméro de campagne
                  CampaignChildIDintNuméro d'envoi
                  EventDatestringDate de l'évènement
                  StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                  CustomFieldValueListCustomFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                  EmailstringAdresse email
                  EventDistinctintNombre d'évènements distincts
                  EventTotalintNombre d'évènements total
                  MobilestringNuméro Mobile

                    GetHardbounceSMSStatsRequest

                    la classe hérite de : BaseMemberSMSStatsRequest
                    ChampTypeDescription
                    Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
                    UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur
                    CampaignIDListint[] (Facultatif) - Liste d'identifiants de campagne
                    StartDatestring(Facultatif) - Date de début
                    EndDatestring(Facultatif) - Date de fin
                    StaticFieldListstring[] (Facultatif) - Liste des noms des champs statiques à retourner
                    SortFieldstring(Facultatif) - Champ à trier par rapport aux champs retournés par la méthode
                    SortOrderSortOrder(Facultatif) - Ordre de tri (ASC / DESC)
                    Offsetint(Facultatif) - Offset de lecture
                    Limitint(Facultatif) - Nombre maximum d'éléments à retourner
                    CustomFieldIDListint[] (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

                    ChampTypeDescription
                    CountintNombre de statistiques de hardbounce d'une compagne SMS
                    HardbounceStatsListHardbounceSMSStats[] Liste des statistiques de hardbounce d'une compagne SMS

                      HardbounceSMSStats

                      la classe hérite de : BaseMemberSMSStats
                      ChampTypeDescription
                      CampaignIDintNuméro de campagne
                      CampaignChildIDintNuméro d'envoi
                      EventDatestringDate de l'évènement
                      StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                      CustomFieldValueListCustomFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                      EmailstringAdresse email
                      EventDistinctintNombre d'évènements distincts
                      EventTotalintNombre d'évènements total
                      MobilestringNuméro Mobile

                        GetUnsubscribeSMSStatsRequest

                        la classe hérite de : BaseMemberSMSStatsRequest
                        ChampTypeDescription
                        Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
                        UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur
                        CampaignIDListint[] (Facultatif) - Liste d'identifiants de campagne
                        StartDatestring(Facultatif) - Date de début
                        EndDatestring(Facultatif) - Date de fin
                        StaticFieldListstring[] (Facultatif) - Liste des noms des champs statiques à retourner
                        SortFieldstring(Facultatif) - Champ à trier par rapport aux champs retournés par la méthode
                        SortOrderSortOrder(Facultatif) - Ordre de tri (ASC / DESC)
                        Offsetint(Facultatif) - Offset de lecture
                        Limitint(Facultatif) - Nombre maximum d'éléments à retourner
                        CustomFieldIDListint[] (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

                        ChampTypeDescription
                        CountintNombre de statistiques de désabonnement d'une compagne SMS
                        UnsubscribeStatsListUnsubscribeSMSStats[] Liste des statistiques de désabonnement d'une compagne SMS

                          UnsubscribeSMSStats

                          la classe hérite de : BaseMemberSMSStats
                          ChampTypeDescription
                          CampaignIDintNuméro de campagne
                          CampaignChildIDintNuméro d'envoi
                          EventDatestringDate de l'évènement
                          StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                          CustomFieldValueListCustomFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                          EmailstringAdresse email
                          EventDistinctintNombre d'évènements distincts
                          EventTotalintNombre d'évènements total
                          MobilestringNuméro Mobile

                            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

                                  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