hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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