hosting

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

Poll one on-demand page check.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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.

פרמטרים

שם	סוג	נדרש	מה זה
`siteId (path)`	`Uuid`	כן	Site ID (UUIDv7).
`checkId (path)`	`string`	כן	The check id returned by `startSiteVitalsCheck`.

תשובה

שם	סוג	נדרש	מה זה
`id`	`string`	כן	—
`url`	`string`	כן	The normalised absolute URL that was (or is being) measured.
`status`	`string<queued, running, done, failed>`	כן	`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`	כן	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`	כן	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`	כן	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`	כן	—
`finished_at`	`string`	לא	—
`result`	`SiteVitals`	לא	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`	כן	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.…

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 429

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