hosting
GET /v1/sites/{siteId}/metrics
Get a site's current usage metrics.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
siteId (path) | Uuid | Так | Site ID (UUIDv7). |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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