Campaign.Get

URL https://api.dpmail.fr/json/Campaign.Get.php

Retourne une collection des campagnes disponibles dans le compte.

Paramètres et infos requises

status - String
Optionnel. Filtre sur l'état d'une campagne. Parmis lesquels :

• DRAFT - Pour retourner les brouillons
• SCHEDULED - Pour retourner les campagnes prêtes à l'envoi
• SENT - Pour remonter les campagnes envoyées

Si ce filtre n'est pas utilisé, toutes les campagnes sont renvoyées. Il est possible d'utiliser 2 valeurs sur ce filtre en séparant par une virgule. Par exemple: DRAFT,SCHEDULED

campaign_name - String
Optionnel. Filtre sur le nom de la campagne. Correspond au SQL LIKE %%.

subject - String
Optionnel. Filtre sur le sujet de la campagne. Correspond au SQL LIKE %%.

created_before - String
Optionnel. Filtre sur la date de création de la campagne. Au format ISO_8601. Soit basiquement AAAA-MM-JJ hh:mm:ss
Retournera les campagnes ayant été créées avant le moment mentionné.

created_after - String
Optionnel. Filtre sur la date de création de la campagne. Au format ISO_8601. Soit basiquement AAAA-MM-JJ hh:mm:ss
Retournera les campagnes ayant été créées après le moment mentionné.

sendtime_before - String
Optionnel. Filtre sur la date d'envoi effective de la campagne. Au format ISO_8601. Soit basiquement AAAA-MM-JJ hh:mm:ss
Retournera les campagnes ayant été envoyées avant le moment mentionné.

sendtime_after - String
Optionnel. Filtre sur la date d'envoi effective de la campagne. Au format ISO_8601. Soit basiquement AAAA-MM-JJ hh:mm:ss
Retournera les campagnes ayant été envoyées après le moment mentionné.

Sort_Field - String
Optionnel. Critère de tri des résultats. Soit created pour classer par date de création de la liste, soit name pour classer par nom. Valeur par défaut: created

Sort_Dir - String
Optionnel. Sens du tri des résultats. Soit ASC , soit DESC.Valeur par défaut: DESC

Start - Integer
Le numéro de la page à laquelle commencer - par défaut 0, la première page

Limit - Integer
Le nombre de résultat à retourner (par page) - par défaut 50 (Max.: 500)

Codes de retour

Succès

0: Success
Un tableau de données contenant les informations sur les différentes campagnes correspondant aux critères de filtrages.

Erreur

8: Un des filtres concernant une date est dans un format incorrect
La date fournie n'est pas valide. Veuillez vous conformer aux règles du format ISO_8601.

Format de données

{
  total: 5,
  data: [
      {
        cid: "1584234",
        name: "Campagne automne 2016",
        date_created: "2016-05-29 15:14:13",
        subject: "Nouvelle collection automne/hiver",
        from_email: "sender@example.tld",
        from_name: "Émilie",
        reply_email: "yesreply@example.tld",
        reply_name: "Service Commercial",
        delivery_mode: "IMMEDIATE",
        scheduled_at: "2016-09-14 18:12:00",
        status: "SENT",
        sended_at: "2016-09-14 18:12:04"
      },
      ...
  ]
}