Service de statistiques
Contrat WSDLhttp://apitmapreprod.dolist.net/v3/StatisticsService.svc?WSDL
Exemple disponible
  • Implémentation en .NET C# 4.0

  • Définition

    Le service de statistiques 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, vos ouvertures, vos clics, vos désabonnés...et intégrer les directement dans votre système d'informations.

    Principe fonctionnement

    Voici quelques règles de fonctionnement pour utiliser au mieux nos API de statistiques.
    • 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.
    • Les statistiques sur le nombre d’aboutis/bounce/pending seront vides si un segment ou une entité gestionnaire est spécifié ainsi que les 30 jours d'envoi de la campagne ont été dépassées.
    • L’IGQ n'est pas statique. Il peut être modifié sur une même campagne tant que la période de calcul n’est pas terminée.
    • 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.

    Statistiques sur les clics

    Nom de la méthode : GetClickStats

    Cette méthode vous permet de récupérer le nombre total de clics ainsi que les informations relatives au clic (date, lien cliqué...) pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetClickStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetClickStatsResultObjet contenant la liste des statistiques de clic 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

    Statistiques sur la réception

    Nom de la méthode : GetDeliveryStats

    Cette méthode vous permet de récupérer le nombre total de messages aboutis ainsi que les informations relatives au contact qui a reçu le message pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetDeliveryStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetDeliveryStatsResultObjet contenant la liste des statistiques de réception 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

    Statistiques sur les hardbounce

    Nom de la méthode : GetHardbounceStats

    Cette méthode vous permet de récupérer le nombre total de messages non aboutis (Hardbounce) ainsi que les raisons de non-réception pour chacun pour les campagnes de la période ou de la liste de recherche.

    Les logs SMTP de vos campagnes sont disponibles pendant les 30 jours qui suivent la date d'envoi de vos campagnes.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetHardbounceStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetHardbounceStatsResultObjet contenant la liste des hardbounces 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

    Statistiques sur les ouvertures

    Nom de la méthode : GetOpenStats

    Cette méthode vous permet de récupérer le nombre total de messages ouverts ainsi que les informations relatives à l'ouverture du message (date d'ouverture, contact qui a ouvert...) pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetOpenStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetOpenStatsResultObjet contenant la liste des statistiques d'ouverture 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

    Statistiques sur le tracking

    Nom de la méthode : GetTrackingStats

    Cette méthode vous permet de récupérer le nombre total de clics par lien défini pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetTrackingStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetTrackingStatsResultObjet contenant la liste des statistiques de tracking 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

    Statistiques sur les desabonnements

    Nom de la méthode : GetUnsubscribeStats

    Cette méthode vous permet de récupérer le nombre total de désabonnés ainsi que les informations relatives au contact pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetUnsubscribeStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetUnsubscribeStatsResultObjet contenant la liste des désabonnements 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

    Statistiques sur le parrainage

    Nom de la méthode : GetSponsorshipStats

    Cette méthode vous permet de récupérer le nombre total de parrainages ainsi que le descriptif des différents parrainages (parrain, adresse email filleule convertie,...) pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetSponsorshipStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetSponsorshipStatsResultObjet contenant la liste des parrainages ainsi que leur nombre
    Liste des erreurs possibles
    Erreurs communes
    CodeNomDescription
    409SaleManagerNotFoundExceptionL'entité gestionnaire demandée n'existe pas
    107SegmentNotFoundExceptionLe segment demandé 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

    Statistiques des campagnes

    Nom de la méthode : GetCampaignStats

    Cette méthode vous retourne les statistiques globales pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetCampaignStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetCampaignStatsResultObjet contenant la liste des statistiques de campagne ainsi que leurs nombres
    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

    Statistiques agrégées des campagnes

    Nom de la méthode : GetCampaignAggregatedStats

    Cette méthode vous retourne les statistiques globales de vos campagnes, agrégées par envois, sur une période de regroupement donnée pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetCampaignAggregatedStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetCampaignAggregatedStatsResultObjet contenant la liste des statistiques agrégées de campagne ainsi que leurs nombres
    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
    921TooLongEventPeriodExceptionPériode de recherche des statistiques dépassée
    922InvalidEventDatePeriodExceptionDate de recherche des statistiques incorrecte

    Statistiques des liens de tracking

    Nom de la méthode : GetCampaignTrackingLinkStats

    Cette méthode vous retourne les statistiques globales par lien ainsi que le nombre de clics brut et distinct pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetCampaignTrackingLinkStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetCampaignTrackingLinkStatsResultObjet contenant la liste des statistiques des liens de tracking de campagne ainsi que leurs nombres
    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

    Statistiques globales des réseaux sociaux

    Nom de la méthode : GetCampaignSocialNetworkStats

    Cette méthode vous retourne le nombre de sociaunotes acquis ou global de votre base pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetCampaignSocialNetworkStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetCampaignSocialNetworkStatsResultObjet contenant la liste des statistiques globales des réseaux sociaux des campagnes ainsi que leurs nombres
    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

    Statistiques des liens de réseaux sociaux

    Nom de la méthode : GetCampaignSocialNetworkClickStats

    Cette méthode vous retourne la ventilation de vos statistiques de clics par lien par sociaunotes pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetCampaignSocialNetworkClickStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetCampaignSocialNetworkClickStatsResultObjet contenant la liste des statistiques de clic des liens de réseaux sociaux de campagne ainsi que leurs nombres
    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

    Statistiques des domaines des campagnes

    Nom de la méthode : GetCampaignDomainStats

    Cette méthode vous retourne la ventilation de vos statistiques comportementales par domaine pour les campagnes de la période ou de la liste de recherche.
    Les paramètres attendus en entrée
    ChampTypeDescription
    authenticationTokenContextAuthenticationTokenContextJeton d'authentification
    requestGetCampaignDomainStatsRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetCampaignDomainStatsResultObjet contenant la liste des statistiques des domaines de campagne ainsi que leurs nombres
    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

    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

      GetClickStatsRequest

      la classe hérite de : BaseMemberStatsRequest
      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
      CampaignChildIDint(Facultatif) - Numéro d'envoi
      SegmentIDint(Facultatif) - Identifiant du segment
      StartDatestring(Facultatif) - Date de début
      EndDatestring(Facultatif) - Date de fin
      SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
      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 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.
      • 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.
      • 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 StaticFieldList sont :
        • MemberID : Identifiant du contact
        • ThemeID : Identifiant du thème associé au lien
        • ThemeName : Description du thème
        • Optout : Identifiant de l’etat du contact email
        • Mobile : Numéro de télephone Mobile
        • OptoutMobile : Identifiant de l’etat du contact mobile
        • SalutationID : Identifiant de la civilité
        • SaleMgtID : Identifiant de l’entité gestionnaire
        • 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
        • LastOpenDate: Date de dernière ouverture du contact
        • LastClickDate: Date de dernier clic du contact
        • SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
        • DeviceID : Identifiant du support de consultation
        • DeviceName : Nom du support de consultation
        • ModelID : Identifiant du modèle
        • ModelName : Nom du modèle
        • BrandID : Identifiant de la marque
        • BrandName : Nom de la marque
        • OsID : Identifiant du système d'exploitation
        • OsName : Nom du système d'exploitation
        • BrowserID : Identifiant du navigateur
        • BrowserName : Nom du navigateur
        • UserAgentID : Identifiant du user agent
        • UserAgentName : Nom du user agent
      • 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.

      BaseMemberStatsRequest

      la classe hérite de : BaseCampaignStatsRequest
      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
      CampaignChildIDint(Facultatif) - Numéro d'envoi
      SegmentIDint(Facultatif) - Identifiant du segment
      StartDatestring(Facultatif) - Date de début
      EndDatestring(Facultatif) - Date de fin
      SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
      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

        BaseCampaignStatsRequest

        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
        CampaignChildIDint(Facultatif) - Numéro d'envoi
        SegmentIDint(Facultatif) - Identifiant du segment
        StartDatestring(Facultatif) - Date de début
        EndDatestring(Facultatif) - Date de fin
        SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
        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

          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

            GetClickStatsResult

            ChampTypeDescription
            CountintNombre de statistiques de clics
            ClickStatsListClickStats[] Liste des statistiques de clics

              ClickStats

              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
              LinkIDintIdentifiant du lien
              UrlstringURL du lien
              • EventDate : Date de clic
              • EventDistinct : Nombre de clics distincts
              • EventTotal : Nombre de clics total

              BaseMemberStats

              la classe hérite de : BaseStats
              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

                BaseStats

                ChampTypeDescription
                CampaignIDintNuméro de campagne
                CampaignChildIDintNuméro d'envoi
                EventDatestringDate de l'évènement
                StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner

                  StaticFieldValue

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

                    CustomFieldValue

                    ChampTypeDescription
                    IDintIdentifiant du champ
                    ValuestringValeur du champ

                      GetDeliveryStatsRequest

                      la classe hérite de : BaseMemberStatsRequest
                      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
                      CampaignChildIDint(Facultatif) - Numéro d'envoi
                      SegmentIDint(Facultatif) - Identifiant du segment
                      StartDatestring(Facultatif) - Date de début
                      EndDatestring(Facultatif) - Date de fin
                      SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                      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.
                      • 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 StaticFieldList sont :
                        • MemberID : Identifiant du contact
                        • Optout : Identifiant de l’état du contact email
                        • Mobile : Numéro de téléphone Mobile
                        • OptoutMobile : Identifiant de l’état du contact mobile
                        • SalutationID : Identifiant de la civilité
                        • SaleMgtID : Identifiant de l’entité gestionnaire
                        • 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
                        • LastOpenDate : Date de dernière ouverture du contact
                        • LastClickDate : Date de dernier clic du contact
                        • SentEmail: Nombre de message envoyés sur ce contact depuis son inscription
                      • 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.

                      GetDeliveryStatsResult

                      ChampTypeDescription
                      CountintNombre de statistiques de réception
                      DeliveryStatsListDeliveryStats[] Liste des statistiques de réception

                        DeliveryStats

                        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
                        • EventDate : Date d'abouti
                        • EventDistinct : Nombre d'aboutis du contact sur la campagne
                        • EventTotal : Nombre d'aboutis total

                        GetHardbounceStatsRequest

                        la classe hérite de : BaseMemberStatsRequest
                        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
                        CampaignChildIDint(Facultatif) - Numéro d'envoi
                        SegmentIDint(Facultatif) - Identifiant du segment
                        StartDatestring(Facultatif) - Date de début
                        EndDatestring(Facultatif) - Date de fin
                        SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                        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 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.
                        • 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 StaticFieldList sont :
                          • MemberID : Identifiant du contact
                          • Optout : Identifiant de l’etat du contact email
                          • Mobile : Numéro de téléphone Mobile
                          • OptoutMobile : Identifiant de l’etat du contact mobile
                          • SalutationID : Identifiant de la civilité
                          • SaleMgtID : Identifiant de l’entité gestionnaire
                          • 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
                          • LastOpenDate : Date de dernière ouverture du contact
                          • LastClickDate : Date de dernier clic du contact
                          • SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
                        • 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.

                        GetHardbounceStatsResult

                        ChampTypeDescription
                        CountintNombre de statistiques de hardbounce
                        HardbounceStatsListHardbounceStats[] Liste des statistiques de hardbounce

                          HardbounceStats

                          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
                          • EventDate : Date d'injoignable
                          • EventDistinct : Nombre de harbounces du contact sur la campagne
                          • EventTotal : Nombre d'injoignables total

                          GetOpenStatsRequest

                          la classe hérite de : BaseMemberStatsRequest
                          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
                          CampaignChildIDint(Facultatif) - Numéro d'envoi
                          SegmentIDint(Facultatif) - Identifiant du segment
                          StartDatestring(Facultatif) - Date de début
                          EndDatestring(Facultatif) - Date de fin
                          SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                          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
                          • 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.
                          • 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 StaticFieldList sont :
                            • MemberID : Identifiant du contact
                            • Optout : Identifiant de l’etat du contact email
                            • Mobile : Numéro de téléphone Mobile
                            • OptoutMobile : Identifiant de l’etat du contact mobile
                            • SalutationID : Identifiant de la civilité
                            • SaleMgtID : Identifiant de l’entité gestionnaire
                            • 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
                            • LastOpenDate : Date de dernière ouverture du contact
                            • LastClickDate : Date de dernier clic du contact
                            • SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
                            • DeviceID : Identifiant du support de consultation
                            • DeviceName : Nom du support de consultation
                            • ModelID : Identifiant du modèle
                            • ModelName : Nom du modèle
                            • BrandID : Identifiant de la marque
                            • BrandName : Nom de la marque
                            • OsID : Identifiant du système d'exploitation
                            • OsName : Nom du système d'exploitation
                            • BrowserID : Identifiant du navigateur
                            • BrowserName : Nom du navigateur
                            • UserAgentID : Identifiant du user agent
                            • UserAgentName : Nom du user agent
                          • 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.

                          GetOpenStatsResult

                          ChampTypeDescription
                          CountintNombre de statistiques d'ouverture
                          OpenStatsListOpenStats[] Liste des statistiques d'ouverture

                            OpenStats

                            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
                            • EventDate : Date d'ouverture
                            • EventDistinct : Nombre d'ouvertures distinctes
                            • EventTotal : Nombre d'ouvertures total

                            GetTrackingStatsRequest

                            la classe hérite de : BaseMemberStatsRequest
                            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
                            CampaignChildIDint(Facultatif) - Numéro d'envoi
                            SegmentIDint(Facultatif) - Identifiant du segment
                            StartDatestring(Facultatif) - Date de début
                            EndDatestring(Facultatif) - Date de fin
                            SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                            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
                            LinkIDListint[] (Facultatif) - Liste des identifiants de lien
                            • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date du clic du contact sur lien défini.
                              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.
                            • 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 StaticFieldList sont :
                              • MemberID : Identifiant du contact
                              • ThemeID : Identifiant du thème associé au lien
                              • ThemeName : Description du thème
                              • Optout : Identifiant de l’etat du contact email
                              • Mobile : Numéro de téléphone Mobile
                              • OptoutMobile : Identifiant de l’etat du contact mobile
                              • SalutationID : Identifiant de la civilité
                              • SaleMgtID : Identifiant de l’entité gestionnaire
                              • 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
                              • LastOpenDate: Date de dernière ouverture du contact
                              • LastClickDate: Date de dernier clic du contact
                              • SentEmail: Nombre de message envoyés sur ce contact depuis son inscription
                              • DeviceID : Identifiant du support de consultation
                              • DeviceName : Nom du support de consultation
                              • ModelID : Identifiant du modèle
                              • ModelName : Nom du modèle
                              • BrandID : Identifiant de la marque
                              • BrandName : Nom de la marque
                              • OsID : Identifiant du système d'exploitation
                              • OsName : Nom du système d'exploitation
                              • BrowserID : Identifiant du navigateur
                              • BrowserName : Nom du navigateur
                              • UserAgentID : Identifiant du user agent
                              • UserAgentName : Nom du user agent
                            • 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.

                            GetTrackingStatsResult

                            ChampTypeDescription
                            CountintNombre de statistiques de tracking
                            TrackingStatsListTrackingStats[] Liste des statistiques de tracking

                              TrackingStats

                              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
                              LinkIDintIdentifiant du lien
                              UrlstringURL du lien
                              • EventDate : Date de clic sur le lien
                              • EventDistinct : Nombre de clics distincts sur le lien
                              • EventTotal : Nombre de clics totals sur le lien

                              GetUnsubscribeStatsRequest

                              la classe hérite de : BaseMemberStatsRequest
                              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
                              CampaignChildIDint(Facultatif) - Numéro d'envoi
                              SegmentIDint(Facultatif) - Identifiant du segment
                              StartDatestring(Facultatif) - Date de début
                              EndDatestring(Facultatif) - Date de fin
                              SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                              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 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.
                              • 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 StaticFieldList sont :
                                • MemberID : Identifiant du contact
                                • Optout : Identifiant de l’etat du contact email
                                • Mobile : Numéro de téléphone Mobile
                                • OptoutMobile : Identifiant de l’etat du contact mobile
                                • SalutationID : Identifiant de la civilité
                                • SaleMgtID : Identifiant de l’entité gestionnaire
                                • 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
                                • LastOpenDate : Date de dernière ouverture du contact
                                • LastClickDate : Date de dernier clic du contact
                                • SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
                              • 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.

                              GetUnsubscribeStatsResult

                              ChampTypeDescription
                              CountintNombre de statistiques de désabonnement
                              UnsubscribeStatsListUnsubscribeStats[] Liste des statistiques de désabonnement

                                UnsubscribeStats

                                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
                                • EventDate : Date de désabonnement
                                • EventDistinct : Nombre de désinscription du contact sur la campagne
                                • EventTotal : Nombre de désabonnements

                                GetSponsorshipStatsRequest

                                la classe hérite de : BaseMemberStatsRequest
                                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
                                CampaignChildIDint(Facultatif) - Numéro d'envoi
                                SegmentIDint(Facultatif) - Identifiant du segment
                                StartDatestring(Facultatif) - Date de début
                                EndDatestring(Facultatif) - Date de fin
                                SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                                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
                                SponsorshipIDListint[] (Facultatif) - Liste des identifiants de parrainage
                                • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date de parrainage 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.
                                • 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 StaticFieldList sont :
                                  • MemberID : Identifiant du contact qui a parrainé
                                  • GodSonEmail : Adresse email du filleul
                                  • QuizzID : Identifiant du quizz a l’origine du parrainage
                                  • ContestID : Identifiant du jeu concours a l’origine du parrainage
                                  • Optout : Identifiant de l’etat du contact email
                                  • Mobile : Numéro de téléphone Mobile
                                  • OptoutMobile : Identifiant de l’etat du contact mobile
                                  • SalutationID : Identifiant de la civilité
                                  • SaleMgtID : Identifiant de l’entité gestionnaire
                                  • 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
                                  • LastOpenDate : Date de dernière ouverture du contact
                                  • LastClickDate : Date de dernier clic du contact
                                  • SentEmail : Nombre de message envoyés sur ce contact depuis son inscription
                                • 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.

                                GetSponsorshipStatsResult

                                ChampTypeDescription
                                CountintNombre de statistiques de parrainage
                                SponsorshipStatsListSponsorshipStats[] Liste des statistiques de parrainage

                                  SponsorshipStats

                                  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
                                  SourceTypeIDintIdentifiant de l’origine
                                  1 - Formulaire d'inscription
                                  2 - Formulaire de désinscription
                                  3 - Formulaire de modification de profil
                                  4 - Formulaire jeux-concours
                                  5 - Formulaire de parrainage
                                  6 - Formulaire coupon-réponse
                                  7 - WebService
                                  8 - Page de confirmation d'inscription
                                  9 - Formulaire questionnaires-enquêtes
                                  10 - Campagne
                                  SponsorshipIDintIdentifiant du parrainage
                                  • EventDate : Date de parrainage
                                  • EventDistinct : Nombre de parrainage du parrain sur la campagne
                                  • EventTotal : Nombre de parrains

                                  GetCampaignStatsRequest

                                  la classe hérite de : BaseCampaignStatsRequest
                                  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
                                  CampaignChildIDint(Facultatif) - Numéro d'envoi
                                  SegmentIDint(Facultatif) - Identifiant du segment
                                  StartDatestring(Facultatif) - Date de début
                                  EndDatestring(Facultatif) - Date de fin
                                  SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                                  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
                                  GetChildListboolean(Facultatif) - Récupérer la liste des campagnes rattachées à une campagne mère
                                  • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
                                    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.
                                  • 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.
                                  • 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 StaticFieldList sont :
                                    • Sent : Nombre de message envoyés
                                    • Canceled : Nombre de message annulés
                                    • Delivered : Nombre de message identifiés en abouti
                                    • HardBounce : Nombre de message identifiés en hardbounce
                                    • Pending : Nombre de message non identifiés ou en diffusion
                                    • Opened : Nombre de destinataires ayant ouverts au moins une fois
                                    • OpenedOnce : Nombre de destinataires ayant ouverts une seule fois
                                    • OpenedMultiple : Nombre de destinataires ayant ouvert plusieurs fois
                                    • OpenedTotal : Nombre d’ouverture brut (ouvertures cumulées)
                                    • Clicked : Nombre destinataires uniques ayant cliqués sur un lien
                                    • ClickedNotTechnical : Nombre de destinataires uniques ayant cliqués sur au moins un lien non technique
                                    • ClickedOnce : Nombre de destinataires uniques ayant cliqués une seule fois sur un lien non technique
                                    • ClickedMultiple : Nombre de destinataires uniques ayant cliqués sur plusieurs liens non technique
                                    • ClickedTotal : Nombre de destinataires ayant cliqués sur un un lien non technique
                                    • Unsubscribed : Nombre de désabonnement
                                    • Complaints : Nombre de plaintes
                                    • GodFathers : Nombre de parrains
                                    • Godsons : Nombre de filleuls
                                    • ConvertedGodsons : Nombre de filleuls convertis
                                    • IGQ : Valeur de l’IGQ
                                    • NbLinks : Nombre de lien du message
                                    • NbLinksNotTechnical : Nombre de lien non technique du message
                                  • 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.
                                  • Récupérer la liste des campagnes rattachées à une campagne mère.

                                  GetCampaignStatsResult

                                  ChampTypeDescription
                                  CountintNombre de statistiques de campagne
                                  CampaignStatsListCampaignStats[] Liste des statistiques de campagne

                                    CampaignStats

                                    la classe hérite de : BaseCampaignStats
                                    ChampTypeDescription
                                    CampaignIDintNuméro de campagne
                                    CampaignChildIDintNuméro d'envoi
                                    EventDatestringDate de l'évènement
                                    StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                                    TestModebooleanCampagne en mode test (0/1)
                                    SendingTypeintType d'envoi
                                    CampaignStatusintStatus de la campagne

                                    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

                                      BaseCampaignStats

                                      la classe hérite de : BaseStats
                                      ChampTypeDescription
                                      CampaignIDintNuméro de campagne
                                      CampaignChildIDintNuméro d'envoi
                                      EventDatestringDate de l'évènement
                                      StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                                      TestModebooleanCampagne en mode test (0/1)
                                      SendingTypeintType d'envoi
                                      CampaignStatusintStatus de la campagne

                                        GetCampaignAggregatedStatsRequest

                                        la classe hérite de : BaseCampaignStatsRequest
                                        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
                                        CampaignChildIDint(Facultatif) - Numéro d'envoi
                                        SegmentIDint(Facultatif) - Identifiant du segment
                                        StartDatestring(Facultatif) - Date de début
                                        EndDatestring(Facultatif) - Date de fin
                                        SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                                        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
                                        AggregatedTypeAggregatedTypeType de regroupement des statistiques par heure (HOUR), par jour (DAY) ou par mois (MONTH)
                                        EventStartDatestringDate de début de l'évènement
                                        EventEndDatestringDate de fin de l'évènement
                                        • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
                                          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.
                                        • 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.
                                        • 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 StaticFieldList sont :
                                          • Delivered : Nombre de message identifiés en abouti
                                          • HardBounce : Nombre de message identifiés en hardbounce
                                          • Opened : Nombre de message ouverts
                                          • OpenedTotal : Nombre d’ouverture brut
                                          • Clicked : Nombre de message cliqués
                                          • ClickedNotTechnical : Nombre de destinataire unique ayant cliqué sur des liens non techniques
                                          • ClickedTotal : Nombre de clics brut
                                          • Unsubscribed : Nombre de désabonnement
                                          • Complaints : Nombre de plaintes
                                        • 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 EventStartDate (date incluse) et EventEndDate (date non incluse) correspondent à la date des évènements.
                                          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.
                                        • AggregatedType : En fonction du type de regroupement des statistiques (HOUR / DAY / MONTH), le champ EventAggregatedDate est retourné et correspond à la date agrégée pour chaque statistique. Le mois, le jour ou l'heure du champ EventAggregatedDate change d'un agrégat à l'autre.

                                        GetCampaignAggregatedStatsResult

                                        ChampTypeDescription
                                        CountintNombre des statistiques agrégées des campagnes
                                        CampaignAggregatedStatsListCampaignAggregatedStats[] Liste des statistiques agrégées

                                          CampaignAggregatedStats

                                          la classe hérite de : BaseCampaignStats
                                          ChampTypeDescription
                                          CampaignIDintNuméro de campagne
                                          CampaignChildIDintNuméro d'envoi
                                          EventDatestringDate de l'évènement
                                          StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                                          TestModebooleanCampagne en mode test (0/1)
                                          SendingTypeintType d'envoi
                                          CampaignStatusintStatus de la campagne
                                          EventAggregatedDatestringDate de la statistique agrégée

                                          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
                                          • EventDate : Date d'envoi de la campagne

                                          GetCampaignTrackingLinkStatsRequest

                                          la classe hérite de : BaseCampaignStatsRequest
                                          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
                                          CampaignChildIDint(Facultatif) - Numéro d'envoi
                                          SegmentIDint(Facultatif) - Identifiant du segment
                                          StartDatestring(Facultatif) - Date de début
                                          EndDatestring(Facultatif) - Date de fin
                                          SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                                          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
                                          • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
                                            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.
                                          • 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.
                                          • 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 StaticFieldList sont :
                                            • LinkName : Nom du lien
                                            • ThemeID : Identifiant du thème
                                            • ThemeName : Description du thème
                                            • ParentLinkID : Identifiant du lien parent
                                            • DynamicComponentID : Identifiant du composant relié
                                            • DynamicRuleID : Identifiant de la règle
                                            • LinkRecipientDistinct : Nombre de destinataires distinct ayant cliqués sur le lien
                                            • LinkClicksTotal : Nombre de clic brut sur le lien
                                            • UrlRecipientDistinct : Nombre de destinataires distinct ayant cliqués sur l’url
                                            • UrlClicksTotal : Nombre de clics brut sur l’url
                                            • ThemeRecipientDistinct : Nombre de destinataires distinct ayant cliqués sur le thème
                                            • ThemeClicksTotal : Nombre de clics brut sur le thème
                                          • 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.

                                          GetCampaignTrackingLinkStatsResult

                                          ChampTypeDescription
                                          CountintNombre de statistiques des liens de tracking
                                          CampaignTrackingLinkStatsListCampaignTrackingLinkStats[] Liste des statistiques des liens de tracking

                                            CampaignTrackingLinkStats

                                            la classe hérite de : BaseCampaignStats
                                            ChampTypeDescription
                                            CampaignIDintNuméro de campagne
                                            CampaignChildIDintNuméro d'envoi
                                            EventDatestringDate de l'évènement
                                            StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                                            TestModebooleanCampagne en mode test (0/1)
                                            SendingTypeintType d'envoi
                                            CampaignStatusintStatus de la campagne
                                            LinkIDintIdentifiant du lien
                                            UrlstringUrl du lien

                                            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
                                            • EventDate : Date du clic sur le lien

                                            GetCampaignSocialNetworkStatsRequest

                                            la classe hérite de : BaseCampaignStatsRequest
                                            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
                                            CampaignChildIDint(Facultatif) - Numéro d'envoi
                                            SegmentIDint(Facultatif) - Identifiant du segment
                                            StartDatestring(Facultatif) - Date de début
                                            EndDatestring(Facultatif) - Date de fin
                                            SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                                            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
                                            • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
                                              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.
                                            • 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.
                                            • 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 StaticFieldList sont :
                                              • Total : Nombre de socionautes (données non disponible pour les BAT)
                                              • Acquired : Nombre de socionautes acquis
                                              • Existing : Nombre de socionautes de la base
                                            • 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.

                                            GetCampaignSocialNetworkStatsResult

                                            ChampTypeDescription
                                            CountintNombre de statistiques globales des réseaux sociaux
                                            CampaignSocialNetworkStatsListCampaignSocialNetworkStats[] Liste des statistiques globales des réseaux sociaux

                                              CampaignSocialNetworkStats

                                              la classe hérite de : BaseCampaignStats
                                              ChampTypeDescription
                                              CampaignIDintNuméro de campagne
                                              CampaignChildIDintNuméro d'envoi
                                              EventDatestringDate de l'évènement
                                              StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                                              TestModebooleanCampagne en mode test (0/1)
                                              SendingTypeintType d'envoi
                                              CampaignStatusintStatus de la campagne

                                              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
                                              • EventDate : Date d'envoi de la campagne

                                              GetCampaignSocialNetworkClickStatsRequest

                                              la classe hérite de : BaseCampaignStatsRequest
                                              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
                                              CampaignChildIDint(Facultatif) - Numéro d'envoi
                                              SegmentIDint(Facultatif) - Identifiant du segment
                                              StartDatestring(Facultatif) - Date de début
                                              EndDatestring(Facultatif) - Date de fin
                                              SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                                              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
                                              • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
                                                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.
                                              • 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.
                                              • 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 StaticFieldList sont :
                                                • ClickedLinks : Nombre de liens cliqués
                                                • Total : Nombre de destinataires ayant cliqué sur au moins un lien
                                                • ClickedOnce : Nombre de destinataires ayant cliqué sur un seul lien
                                                • ClickedMultiple : Nombre de destinataires ayant cliqué sur plusieurs liens
                                              • 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.

                                              GetCampaignSocialNetworkClickStatsResult

                                              ChampTypeDescription
                                              CountintNombre de statistiques de clic des réseaux sociaux
                                              CampaignSocialNetworkClickStatsListCampaignSocialNetworkClickStats[] Liste des statistiques des clics des réseaux sociaux

                                                CampaignSocialNetworkClickStats

                                                la classe hérite de : BaseCampaignStats
                                                ChampTypeDescription
                                                CampaignIDintNuméro de campagne
                                                CampaignChildIDintNuméro d'envoi
                                                EventDatestringDate de l'évènement
                                                StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                                                TestModebooleanCampagne en mode test (0/1)
                                                SendingTypeintType d'envoi
                                                CampaignStatusintStatus de la campagne
                                                LinkTypeintIdentifiant du type de lien (Suivi / Partage)
                                                SocialNetworkIDintIdentifiant du réseau social (Facebook, Twitter, …)

                                                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

                                                Les valeurs possibles pour SocialNetworkID sont :
                                                • 1 - Facebook
                                                • 2 - Twitter
                                                • 3 - LinkedIn
                                                • 4 - Viadeo

                                                Les valeurs possibles pour LinkType sont :
                                                • 1 - Lien de partage
                                                • 2 - Lien de suivi
                                                • EventDate : Date du clic sur le lien de réseaux sociaux

                                                GetCampaignDomainStatsRequest

                                                la classe hérite de : BaseCampaignStatsRequest
                                                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
                                                CampaignChildIDint(Facultatif) - Numéro d'envoi
                                                SegmentIDint(Facultatif) - Identifiant du segment
                                                StartDatestring(Facultatif) - Date de début
                                                EndDatestring(Facultatif) - Date de fin
                                                SaleMgtIDint(Facultatif) - Identifiant de l'entité gestionnaire
                                                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
                                                • Les paramètres StartDate (date incluse) et EndDate (date non incluse) correspondent à la date d’envoi des campagnes.
                                                  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.
                                                • 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.
                                                • 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 StaticFieldList sont :
                                                  • Sent : NNombre de message envoyés
                                                  • Delivered : Nombre de message identifiés en abouti
                                                  • HardBounce : Nombre de message identifiés en hardbounce
                                                  • Pending : Nombre de message non identifiés ou en diffusion
                                                  • Spammed : Nombre de message identifié en spam temporaire
                                                  • Opened : Nombre de message ouverts
                                                  • ClickedNotTechnical : Nombre de message cliqués hors liens techniques
                                                  • Unsubscribed : Nombre de désabonnement
                                                  • Complaints : Nombre de plaintes
                                                • 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.

                                                GetCampaignDomainStatsResult

                                                ChampTypeDescription
                                                CountintNombre de statistiques de domaine
                                                CampaignDomainStatsListCampaignDomainStats[] Liste des statistiques de domaine

                                                  CampaignDomainStats

                                                  la classe hérite de : BaseCampaignStats
                                                  ChampTypeDescription
                                                  CampaignIDintNuméro de campagne
                                                  CampaignChildIDintNuméro d'envoi
                                                  EventDatestringDate de l'évènement
                                                  StaticFieldValueListStaticFieldValue[] (Facultatif) - Liste des noms des champs statiques à retourner
                                                  TestModebooleanCampagne en mode test (0/1)
                                                  SendingTypeintType d'envoi
                                                  CampaignStatusintStatus de la campagne
                                                  DomainstringDomaine du contact

                                                  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
                                                  • EventDate : Date d'envoi de la campagne

                                                  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