hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | Ne | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | Ne | ⛔ 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 | Ne | Free-text match on sender, recipient or subject. |
page (query) | integer | Ne | — |
page_size (query) | integer | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
data | SiteMailLogEntry[] | Ano | — |
total | integer | Ano | — |
page | integer | Ano | — |
page_size | integer | Ano | — |
has_more | boolean | Ano | The vendor's own flag, not arithmetic on `total`. |
period | string | Ano | — |
direction | string | Ano | — |
periods | string[] | Ano | — |
directions | string[] | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429 · 503