API Export des statistiques


Vous pouvez avoir besoin d'exporter des contacts et des données diverses depuis Symplify.
Si vous n'êtes pas familier avec l'API REST de Symplify, commencez ici.



Pour lancer une exportation, vous devez décider quelles données vous voulez et pour quelle timeperiod vous les voulez. Comme les données sont par message, le fichier peut devenir volumineux si vous choisissez de le faire sur une longue période. La méthode recommandée est d'exporter les données une fois par jour.

Les valeurs de timeperiod possibles sont les suivantes :

  • TODAY
  • LAST_DAY
  • LAST_3_DAYS
  • LAST_WEEK
  • LAST_2_WEEKS

Les valeurs d'exportation possibles sont les suivantes:

  • LISTS
  • CAMPAIGNS
  • MESSAGES
  • OPENS
  • SENT
  • CLICKS
  • PROJECTS
  • HARD_BOUNCES
  • SOFT_BOUNCES
  • OPTOUTS

Les deux valeurs doivent être placées dans une structure json qui sera envoyée avec la requête POST.

Après avoir recueilli tous ces renseignements, il est temps de faire la demande.

La réponse, si tout s'est bien passé, contiendra un identifiant unique qui sera utilisé plus tard.

Pour démarrer l'exportation, une requête POST avec des métadonnées décrivant l'importation est envoyée :


POST <server>/rest/<customerId>/batches/exports/statistics
{
“exportType”: “OPENED”,
“period”: “LAST_2_WEEKS”
}

Exemple de corps de réponse


{
“batchId”: “101111”}

Vous pouvez interroger l'API pour suivre la progression de l'exportation. Utilisez le batchId de la requête précédente :

GET <server>/rest/<customerId>/batches/<batchId>

Corps de réponse

{
“id”: 101111,
“type”: “ STAT_EXPORT”,
“customerId”: 0,
“startTime”: 1394636797030,
“endTime”: 1394636799710,
“affected”: 500,
“processed”: 500,
“total”: 501,
“status”: “ PENDING|IN_PROGRESS|FINISHED”
}

Lorsque vous obtenez un status=FINISHED, le fichier est disponible pour être récupéré.

GET <server>/rest/<customerId>/batches/<batchId>/result/url

Le résultat sera une URL que vous pourrez utiliser pour récupérer le fichier exporté. L'url ressemblera à ceci :
https://carma-filetransfer.s3-eu-west-1.amazonaws.com/result/5004/3232465_result.json?Expires=1403187484&AWSAccessKeyId=AKIAJNJRZJQCQ3W66YIQ&Signature=FWZp8noVyxcOflH27k2W7MuNcmM%3D
 
REMARQUE : Les données de retour sont en texte/en clair, donc assurez-vous de ne pas utiliser application/json comme en-tête d'acceptation pour l'appel.
Vous pouvez également utiliser l'URL suivante pour être redirigé vers le résultat stocké sur amazon s3.

GET <server>/rest/<customerId>/batches/<batchId>/result

 

Cet article vous a-t-il été utile?
Utilisateurs qui ont trouvé cela utile : 0 sur 0