Aller à la documentation
API

Statistiques de diffusion

Les résultats de la diffusion : copies envoyées, remises, rebondies, signalées comme spam et échouées, et nombre de personnes ayant ouvert, cliqué et s'étant désabonnées, en totaux et en série découpée selon `grain`.

GETapi.openemail.uk/broadcasts/{id}/stats

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

GET /broadcasts/{id}/stats

Les résultats de la diffusion : copies envoyées, remises, rebondies, signalées comme spam et échouées, et nombre de personnes ayant ouvert, cliqué et s'étant désabonnées, en totaux et en série découpée selon grain.

Paramètres

idstringobligatoire
Dans le chemin. Un identifiant `brd_` issu de `POST /broadcasts` ou `GET /broadcasts`.
grainstring
Largeur des intervalles de la série : `minute`, `hour` ou `day`. `hour` par défaut.
offsetMinutesinteger
Minutes à l'est d'UTC dans lesquelles découper les intervalles, de -840 à 840. 0 par défaut. Passez `-new Date().getTimezoneOffset()` pour le fuseau local.

Exemple

Exige emails:read.

curl
curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/stats?grain=day" -H "$AUTH"
Réponse
{  "object": "broadcast_stats",  "broadcastId": "brd_5a8c1e3f7b2d94a06c8e1f3b",  "grain": "day",  "totals": {    "recipients": 412,    "pending": 0,    "sent": 410,    "delivered": 404,    "bounced": 4,    "complained": 1,    "failed": 2,    "opened": 187,    "clicked": 52,    "unsubscribed": 3,    "opens": 296,    "clicks": 71  },  "series": [    { "bucket": "2026-09-23", "delivered": 404, "opened": 161, "clicked": 45, "unsubscribed": 3 },    { "bucket": "2026-09-24", "delivered": 0, "opened": 26, "clicked": 7, "unsubscribed": 0 }  ]}

opened, clicked et unsubscribed comptent des personnes, tandis que opens et clicks comptent des événements. pending compte les copies encore en file d'attente, programmées ou en cours d'envoi, et failed les copies échouées ou annulées.

series est clairsemée et commence par le plus ancien : un intervalle par grain dans lequel quelque chose s'est produit. Elle compte chaque personne une seule fois, au premier moment où cela lui est arrivé, si bien que son total correspond aux totaux.

bucket est au format YYYY-MM-DD, YYYY-MM-DDTHH ou YYYY-MM-DDTHH:MM, dans le décalage demandé.

Refus

StatutCodeQuand
400invalid_cursorSur la liste des destinataires, un cursor que cette liste n'a pas fourni.
403insufficient_scopeLa clé ne détient pas emails:read.
404broadcast_not_foundL'id ne désigne aucune diffusion de cet espace de travail, ou la clé est limitée à certaines adresses ou certains domaines et la diffusion est partie d'une adresse qu'elle ne détient pas.
404recipient_not_foundSur GET /broadcasts/{id}/recipients/{emailId}, un emailId qui n'est pas une copie de cette diffusion.