hosting

GET `/v1/sites/{siteId}/vitals/checks/{checkId}`

Poll one on-demand page check.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vitals/checks/{checkId} \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`siteId (path)`	`Uuid`	Da	Site ID (UUIDv7).
`checkId (path)`	`string`	Da	The check id returned by `startSiteVitalsCheck`.

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`string`	Da	—
`url`	`string`	Da	The normalised absolute URL that was (or is being) measured.
`status`	`string<queued, running, done, failed>`	Da	`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`	Da	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`	Da	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`	Da	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`	Da	—
`finished_at`	`string`	Ne	—
`result`	`SiteVitals`	Ne	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`	Da	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…

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 429

GET /v1/sites/{siteId}/vitals/checks/{checkId}