一覧と取得
メッセージを探し、その後どうなったかを見る。
このページの3件の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。
一覧
GET /emails は新しい順に返します。status（カンマ区切り）と from で絞り込めます。ページングはオフセットではなくキーセット方式なので、渡された nextCursor を返してください。オフセットページングは、ページを繰っている間に新しいメッセージが届くと、黙って行を飛ばします。
{ "object": "list", "data": [ … ], "hasMore": true, "nextCursor": "msg_01j8…" }トラッキングされた行には、コンパクトな tracking オブジェクトも含まれます。opens、clicks、opened、clicked、openCount、clickCount、firstOpenAt です。トラッキングされていない行には tracking キー自体がありません。ピクセルを一度も含まなかったメッセージの openCount: 0 は「誰も開かなかった」と読めてしまいますが、それは当方が主張できる立場にない内容だからです。
1 件を取得する
GET /emails/{id} は、受信者ごとの配信状態と、一覧の要約ではなく完全なトラッキングレポートを添えてメッセージを返します。1 件の取得であれば、受信者ごとの内訳とリンクを載せる余裕があるからです。存在しない id は 404 であり、でっち上げの成功を返すことはありません。
| 受信者ステータス | 意味 |
|---|---|
| pending | まだ送出されていません。 |
| delivered | このアドレスについて、トランスポートに引き渡されました。 |
| failed | トランスポートが受け付けを拒否しました。 |
| uncertain | トランスポートが途中で失敗し、どの受信者に届いたかを特定できません。どちらかに推測するのではなく、そのまま示します。 |
イベント
GET /emails/{id}/events は履歴を古い順に返します。email.accepted、email.queued、email.scheduled、email.sent、email.failed、email.cancelled、email.rescheduled、そしてトラッキングされたメッセージでは発生に応じて email.opened、email.clicked、email.downloaded です。ポーリングではなく通知を受け取りたい場合は、webhook を登録してください。