Lister et récupérer
Retrouver des messages, et voir ce que l'un d'eux est devenu.
Exécute n'importe lequel des 3 appels de cette page sur votre espace de travail, avec votre propre clé.
Le listage
GET /emails, du plus récent au plus ancien. Filtrez avec status (séparé par des virgules) et from. La pagination est par keyset, pas par offset : renvoyez le nextCursor qui vous a été donné. Une pagination par offset saute silencieusement des lignes quand de nouveaux messages arrivent pendant que vous paginez.
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }Une ligne qui a été suivie porte en plus un objet tracking compact : opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Une ligne qui ne l'a pas été ne porte aucune clé tracking : openCount: 0 sur un message qui n'a jamais contenu de pixel se lirait comme « personne ne l'a ouvert », une affirmation que nous ne sommes pas en mesure de faire.
Récupérer un message
GET /emails/{id} renvoie le message avec l'état de remise destinataire par destinataire, et le rapport de suivi COMPLET plutôt que le résumé de la liste, car une récupération unitaire peut se permettre le détail par destinataire et les liens. Un id qui n'existe pas donne un 404, jamais un succès fabriqué.
| Statut du destinataire | Signification |
|---|---|
| pending | Pas encore transmis. |
| delivered | Remis au transport pour cette adresse. |
| failed | Le transport l'a refusé. |
| uncertain | Un transport a échoué en cours de route et ne peut pas dire quels destinataires il a atteints. Affiché tel quel plutôt que deviné dans un sens ou dans l'autre. |
Événements
GET /emails/{id}/events renvoie la piste, du plus ancien au plus récent : email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled et, sur un message suivi, email.opened, email.clicked et email.downloaded au fur et à mesure. Pour en être averti plutôt que de les interroger en boucle, enregistrez un webhook.