hosting
GET /v1/sites/{siteId}/vitals/checks/{checkId}
Poll one on-demand page check.
Authentication
Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vitals/checks/{checkId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
checkId (path) | string | Yes | The check id returned by startSiteVitalsCheck. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
url | string | Yes | The normalised absolute URL that was (or is being) measured. |
status | string<queued, running, done, failed> | Yes | 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 | Yes | 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 was… |
error | string | Yes | 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… |
error_code | string | Yes | 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… |
created_at | string | Yes | — |
finished_at | string | No | — |
result | SiteVitals | No | 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 that… |
remaining_today | object | Yes | 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.… |
Errors this endpoint can return
401 · 403 · 404 · 429