hosting
GET /v1/sites/{siteId}/vitals/checks/{checkId}
Poll one on-demand page check.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Ushbu yakuniy nuqta spetsifikatsiyada ma'lum bir ruxsatni ko'rsatmaydi, shuning uchun kalitingizga eng kam kerakli huquqni bering va taxmin qilish o'rniga javobni tekshiring.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vitals/checks/{checkId} \
-H "Authorization: Bearer zdk_live_…"Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
Returns the check's current `status` and, once it is `done`, the measurement inline as `result` — the same shape `getSiteVitals` returns, so a client renders one component for both. Scoped to the organisation **and** the site, so a check id belonging to another of the caller's own sites does not resolve here either: the poll URL must not become a way to enumerate what else has been measured. `failed` carries an `error` sentence written for a customer to act on — a page that is unreachable, blocked to crawlers, or redirecting. It is never a stack trace.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
siteId (path) | Uuid | Ha | Site ID (UUIDv7). |
checkId (path) | string | Ha | The check id returned by `startSiteVitalsCheck`. |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | string | Ha | — |
url | string | Ha | The normalised absolute URL that was (or is being) measured. |
status | string<queued, running, done, failed> | Ha | `failed` is a finished state with a customer-readable `error`, not an infrastructure fault — a page that is down or blocked to crawlers reaches it. |
cached | boolean | Ha | True when this is a stored measurement of the same URL served from the cache window rather than a run that was just started. Render `measured_at` rather than implying the page w… |
error | string | Ha | Empty unless `status` is `failed`. A sentence written for a customer to act on; never a stack trace or an internal hostname. **English, and a FALLBACK** — it is authored server-… |
error_code | string | Ha | A stable machine reason the client turns into a localised sentence: `no_data`, `no_result`, `check_failed`, `timed_out`. Empty unless `status` is `failed`. New members are addit… |
created_at | string | Ha | — |
finished_at | string | Yo'q | — |
result | SiteVitals | Yo'q | The measurement, present once `status` is `done`. Null while queued or running and on failure — never a zeroed placeholder, which would render as a real measurement of a page th… |
remaining_today | object | Ha | Checks left in this organisation's rolling daily allowance, so the UI can warn before the button is refused rather than only explaining a `429` afterwards. **`null` means no cap… |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 429