Listázás és lekérés
Üzenetek keresése, és annak megtekintése, mi lett eggyel.
Az oldalon lévő 3 hívás bármelyikét lefuttatja a munkaterületén, a saját kulcsával.
Listázás
GET /emails, a legújabbakkal kezdve. Szűrj a status (vesszővel elválasztva) és a from paraméterrel. A lapozás keyset alapú, nem offset: add tovább a kapott nextCursor értéket. Az offsetes lapozás csendben kihagy sorokat, ha lapozás közben új üzenetek érkeznek.
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }A követett sorok egy tömör tracking objektumot is visznek: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. A nem követett sorokon egyáltalán nincs tracking kulcs: az openCount: 0 egy olyan üzeneten, amely soha nem hordozott pixelt, úgy olvasódik, hogy „senki nem nyitotta meg”, márpedig ezt az állítást nem áll módunkban megtenni.
Egy lekérése
A GET /emails/{id} az üzenetet adja vissza címzettenkénti kézbesítési állapottal és a TELJES követési jelentéssel a listaösszegzés helyett, mert egyetlen lekérés megengedheti magának a címzettenkénti bontást és a linkeket. A nem létező azonosító 404, soha nem kitalált siker.
| Címzett státusza | Jelentése |
|---|---|
| pending | Még nem továbbítottuk. |
| delivered | Átadtuk a transzportnak erre a címre. |
| failed | A transzport elutasította. |
| uncertain | A transzport félúton elbukott, és nem tudja megmondani, mely címzettekig jutott el. Önmagaként jelenítjük meg, nem találgatjuk egyik irányba sem. |
Események
A GET /emails/{id}/events a nyomvonalat adja vissza, a legrégebbivel kezdve: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled, követett üzeneten pedig email.opened, email.clicked és email.downloaded, ahogy bekövetkeznek. Ha nem pollozni akarsz értük, hanem értesülni róluk, regisztrálj egy webhookot.