hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
प्रमाणन
एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।
यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
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