hosting
GET /v1/sites/{siteId}/vitals/checks/{checkId}
Poll one on-demand page check.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vitals/checks/{checkId} \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
siteId (path) | Uuid | Evet | Site ID (UUIDv7). |
checkId (path) | string | Evet | The check id returned by `startSiteVitalsCheck`. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | string | Evet | — |
url | string | Evet | The normalised absolute URL that was (or is being) measured. |
status | string<queued, running, done, failed> | Evet | `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 | Evet | 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 | Evet | 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 | Evet | 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 | Evet | — |
finished_at | string | Hayır | — |
result | SiteVitals | Hayır | 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 | Evet | 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… |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 429