Service de gestion des courriels de synthèse
Contrat WSDLhttp://api.dolist.net/V3/CampaignReportingService.svc?wsdl
Exemple disponible

Définition

Le service de gestion des courriels de synthèse va vous permettre d'effectuer des demandes de rapport de statistiques de campagne automatique ou ponctuel.
En fonction de la fréquence que vous aurez choisi, vous pourrez recevoir, par e-mail, le rapport de statistiques de votre campagne au format CSV ou PDF.

Création d'une demande automatique de rapport de statistiques d'une campagne

Nom de la méthode : CreateAutomaticStatisticReport

Définissez le format de votre rapport de statistiques, planifiez la génération (tous les jours pendant 5 jours, le 5ème jour après la fin de l'envoi) et recevez automatiquement un e-mail avec votre rapport.
Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextJeton d'authentification
requestCreateAutomaticStatisticReportRequestParamètres de la requête

Création d'une demande ponctuelle de rapport de statistiques d'une campagne

Nom de la méthode : CreateOneTimeStatisticReport

Définissez le format de votre rapport de statistiques et recevez automatiquement un e-mail avec votre rapport.
Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextJeton d'authentification
requestCreateOneTimeStatisticReportRequestParamètres de la requête

AuthenticationTokenContext

Le paramètre Key doit être renseigné avec le token renvoyé par le service d'Authentification.
ChampTypeDescription
AccountIDintIdentifiant du client
KeystringClé du jeton d'authentification
ListIDintIdentifiant du client: obsolète. Utilisez AccountID à la place

    CreateAutomaticStatisticReportRequest

    ChampTypeDescription
    CampaignIDintIdentifiant de la campagne
    ReportStatisticReportDetailsDétail du rapport
    PlanningPlanningReportPlanning

    PlanningReport
    • OnceAfterCampaignEnd : Le 5ème jour après la fin de l'envoi.
    • DuringCampaign : Tous les jours pendant 5 jours après la fin de l'envoi.

    StatisticReportDetails

    Description de la demande de rapport.
    ChampTypeDescription
    CSVFormatbooleanGénérer le format CSV (0/1)
    CulturestringLangue du rapport (ex: fr-FR)
    PDFFormatbooleanGénérer le format PDF (0/1)
    RecipientGroupIDintIdentifiant du groupe de destinataires (facultatif)

    RecipientGroupID: Identifiant du groupe de destinataires. Disponible à partir de l'API de gestion des groupes de destinataires.

      CreateOneTimeStatisticReportRequest

      ChampTypeDescription
      CampaignIDintIdentifiant de la campagne
      ReportStatisticReportDetailsDétails du rapport

        ServiceException

        Exception renvoyée en cas d'erreur à l'appel d'une méthode.
        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