hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
siteId (path) | Uuid | Igen | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | Nem | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | Nem | ⛔ 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 | Nem | Free-text match on sender, recipient or subject. |
page (query) | integer | Nem | — |
page_size (query) | integer | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
data | SiteMailLogEntry[] | Igen | — |
total | integer | Igen | — |
page | integer | Igen | — |
page_size | integer | Igen | — |
has_more | boolean | Igen | The vendor's own flag, not arithmetic on `total`. |
period | string | Igen | — |
direction | string | Igen | — |
periods | string[] | Igen | — |
directions | string[] | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422 · 429 · 503