Aller à la documentation
API

Compter qui une diffusion atteindrait

Les chiffres dont partirait un envoi à ces audiences, sans rien envoyer ni écrire : combien de personnes il atteindrait, combien sont ignorées parce qu'elles se sont désabonnées, et combien parce que leur adresse est supprimée. Un contact présent dans plusieurs audiences compte une fois.

POSTapi.openemail.uk/broadcasts/preview

Exécute le véritable appel sur votre espace de travail, avec votre propre clé.

POST /broadcasts/preview

Les chiffres dont partirait un envoi à ces audiences, sans rien envoyer ni écrire : combien de personnes il atteindrait, combien sont ignorées parce qu'elles se sont désabonnées, et combien parce que leur adresse est supprimée. Un contact présent dans plusieurs audiences compte une fois.

Exemple

N'exige que audiences:read, si bien qu'une clé qui ne peut pas envoyer peut tout de même montrer le chiffre à quelqu'un. audienceIds contient de 1 à 10 identifiants et rien d'autre n'est accepté dans le corps.

curl
curl -X POST "$OE/broadcasts/preview" -H "$AUTH" -H 'content-type: application/json' -d '{  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71", "aud_7e3d9a1c5b2f84e06d9a3c51"]}'
Réponse
{  "object": "broadcast_preview",  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71", "aud_7e3d9a1c5b2f84e06d9a3c51"],  "recipients": 412,  "unsubscribed": 9,  "suppressed": 3}

unsubscribed compte les contacts qui se sont désabonnés de chacune de ces audiences dont ils font partie. Un contact encore abonné à l'une d'elles est compté dans recipients.

suppressed compte les contacts abonnés dont l'adresse figure sur la liste de suppression après un rebond ou une plainte, ou parce que quelqu'un l'y a ajoutée.

Le chiffre est pris au moment de l'appel. Un identifiant qui ne désigne aucune audience donne un 404 audience_not_found.