hosting
GET /v1/sites/{siteId}/metrics
Get a site's current usage metrics.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/metrics \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
Point-in-time usage for the Overview panel — disk, bandwidth, visits, the PHP version, the TLS state, and a short daily bandwidth series for the usage chart. RLS-scoped to a site the caller can view (sites.view); an out-of-scope or unknown id is a 404, exactly like getSite. Collection is asynchronous. Metrics are gathered off the request path (a scheduled pull from the site's fleet worker into a cached store — never a live per-request driver call, CLAUDE.md §2.16) and read back here. Until a sample has been collected — a freshly-provisioned or suspended site, or a site on a worker not yet reporting — available is false, collected_at is null and the usage counters are null; the shape is stable so the client renders "usage not yet available" without a contract change once the collector populates it.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
siteId (path) | Uuid | Иә | Site ID (UUIDv7). |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
available | boolean | Иә | Whether a metrics sample has been collected for this site yet. |
disk_used_mb | object | Иә | Disk the site is using, in MB, from the newest stored hourly reading. null when nothing has measured it yet or when the newest reading is too old to present as current — the… |
disk_limit_mb | object | Иә | The disk ceiling ENFORCED on the box, in MB, as last stored. null when no ceiling is recorded. ⛔ Not the plan allowance — see getSiteQuota, which returns both separately… |
bandwidth_mb | object | Иә | Bandwidth used in the current period. |
visits | object | Иә | — |
php_version | string | Жоқ | The PHP version the site runs; empty when not applicable/unknown. |
serving_ok | object | Жоқ | Whether the site actually answered over HTTPS from outside the box at serving_checked_at, established by the recurring serving sweep rather than on this request. null… |
serving_checked_at | object | Жоқ | When a DEFINITE serving verdict was last obtained; null until one has been. Deliberately separate from the sweep's rotation cursor, which advances for every site the sweep… |
serving_detail | string | Жоқ | The short status line behind serving_ok — "HTTP 522", "ConnectTimeout". Never a raw vendor response body. |
ssl_status | string<active, pending, none, unknown> | Жоқ | The site's TLS certificate state. |
ssl_expires_at | object | Жоқ | — |
bandwidth_series | integer[] | Иә | Recent daily bandwidth samples (MB), oldest first — for the usage chart. Empty when unavailable. |
collected_at | object | Иә | When this sample was collected; null when unavailable. |
error_rate | SiteErrorRate | Иә | HTTP and PHP errors for one site over the newest closed collection window (#626). What features/uptime-monitoring sells:… |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 404 · 429