hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Paginated by the vendor, so `has_more` is its own answer rather than arithmetic on `total`. An empty page for a site with no mail is a normal state, not a failure. ⛔ Requires **`sites.panel_access`**, not `sites.view` — unlike every other read on this panel. Sender, recipient and subject lines are the customer's correspondence, the same class of data as their files and their database, and `sites.panel_access` is the key that already gates both. A principal holding only `sites.view` gets a 404.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | いいえ | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | いいえ | ⛔ One direction at a time — the vendor has no "both", so a client showing a combined view must make two calls and say which is which. |
search (query) | string | いいえ | Free-text match on sender, recipient or subject. |
page (query) | integer | いいえ | — |
page_size (query) | integer | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | SiteMailLogEntry[] | はい | — |
total | integer | はい | — |
page | integer | はい | — |
page_size | integer | はい | — |
has_more | boolean | はい | The vendor's own flag, not arithmetic on `total`. |
period | string | はい | — |
direction | string | はい | — |
periods | string[] | はい | — |
directions | string[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503