Výpis a načtení
Najděte zprávy a zjistěte, co se s některou stalo.
Spustí kterékoli z 3 volání na této stránce proti vašemu pracovnímu prostoru, s vaším vlastním klíčem.
Výpis
GET /emails, od nejnovějších. Filtrujte pomocí status (oddělené čárkami) a from. Stránkuje se keysetem, ne offsetem: posílejte zpět nextCursor, který jste dostali. Stránkování offsetem potichu přeskakuje řádky, když během procházení přijdou nové zprávy.
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }Řádek, který byl sledován, nese navíc kompaktní objekt tracking: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Řádek, který sledován nebyl, nenese klíč tracking vůbec: openCount: 0 u zprávy, která nikdy žádný pixel neobsahovala, se čte jako „nikdo ji neotevřel“, a to je tvrzení, ke kterému nemáme žádný podklad.
Načtení jedné zprávy
GET /emails/{id} vrátí zprávu se stavem doručení pro každého příjemce a ÚPLNÝ report o sledování místo souhrnu z výpisu, protože jedno načtení si může rozpad po příjemcích i odkazy dovolit. Id, které neexistuje, je 404, nikdy vymyšlený úspěch.
| Stav příjemce | Význam |
|---|---|
| pending | Zatím neodesláno. |
| delivered | Předáno transportu pro tuto adresu. |
| failed | Transport ji odmítl. |
| uncertain | Transport selhal v půli cesty a neumí říct, ke kterým příjemcům se dostal. Zobrazuje se tak, jak je, místo aby se hádalo na jednu nebo druhou stranu. |
Události
GET /emails/{id}/events vrátí stopu, od nejstarší: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled a u sledované zprávy email.opened, email.clicked a email.downloaded, jak nastávají. Chcete-li se o nich dozvědět, místo abyste se na ně opakovaně dotazovali, zaregistrujte webhook.