hosting
GET /v1/sites/{siteId}/vitals/checks/{checkId}
Poll one on-demand page check.
प्रमाणीकरण
एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।
यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।
प्रयास गर्नुहोस्
कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।
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