Lista i pobieranie
Znajdź wiadomości i sprawdź, co się stało z daną.
Uruchamia dowolne z 3 wywołań na tej stronie na twojej przestrzeni roboczej, twoim własnym kluczem.
Listowanie
GET /emails, od najnowszych. Filtruj przez status (rozdzielany przecinkami) i from. Stronicowanie jest typu keyset, nie offset: przekazuj otrzymany nextCursor. Stronicowanie po offsecie po cichu pomija wiersze, gdy w trakcie przeglądania przychodzą nowe wiadomości.
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }Wiersz, który był śledzony, niesie też zwięzły obiekt tracking: opens, clicks, opened, clicked, openCount, clickCount, firstOpenAt. Wiersz, który nie był, nie ma klucza tracking w ogóle: openCount: 0 na wiadomości, która nigdy nie miała piksela, czyta się jako „nikt jej nie otworzył”, a takiego twierdzenia nie jesteśmy w stanie postawić.
Pobieranie pojedynczej
GET /emails/{id} zwraca wiadomość ze stanem doręczenia dla każdego odbiorcy oraz PEŁNY raport śledzenia zamiast podsumowania z listy, bo pojedyncze pobranie może sobie pozwolić na rozbicie po odbiorcach i na linki. Nieistniejące id daje 404, nigdy zmyślonego sukcesu.
| Status odbiorcy | Znaczenie |
|---|---|
| pending | Jeszcze nieprzesłana. |
| delivered | Przekazana transportowi dla tego adresu. |
| failed | Transport ją odrzucił. |
| uncertain | Transport zawiódł w połowie i nie potrafi powiedzieć, do których odbiorców dotarł. Pokazywany jako on sam, zamiast zgadywania w którąkolwiek stronę. |
Zdarzenia
GET /emails/{id}/events zwraca ślad zdarzeń, od najstarszych: email.accepted, email.queued, email.scheduled, email.sent, email.failed, email.cancelled, email.rescheduled, a na wiadomości śledzonej także email.opened, email.clicked i email.downloaded, w miarę jak zachodzą. Aby dostawać je od nas, zamiast o nie odpytywać, zarejestruj webhook.