ການພິສູດຕົວຕົນ

ສົ່ງ API key ເປັນ bearer token. ຈຸດເຊື່ອມຕໍ່ (endpoint) ນີ້ບໍ່ໄດ້ລະບຸສິດອະນຸຍາດສະເພາະໃດໜຶ່ງໃນຂໍ້ກຳນົດ, ດັ່ງນັ້ນຈຶ່ງຄວນໃຫ້ສິດ key ຂອງທ່ານເທົ່າທີ່ຈຳເປັນໜ້ອຍທີ່ສຸດ ແລະ ກວດສອບການຕອບກັບ ໂດຍບໍ່ຄວນທາດເດົາເອົາເອງ.

ຈຸດເຊື່ອມຕໍ່ນີ້ບໍ່ໄດ້ຮັບ ID ອົງກອນ. ລະຫັດຂອງທ່ານໄດ້ລະບຸອົງກອນທີ່ມັນຂຶ້ນກັບແລ້ວ, ແລະ ຄໍາຕອບແມ່ນຖືກຈໍາກັດຂອບເຂດໄວ້ສໍາລັບອົງກອນນັ້ນ.

ລອງໃຊ້ເບິ່ງ

ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.

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.

ຖືກໂຈະ

ຊື່ປະເພດຕ້ອງການສິ່ງທີ່ມັນເປັນ
idstringແມ່ນແລ້ວ
urlstringແມ່ນແລ້ວThe normalised absolute URL that was (or is being) measured.
statusstring<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.
cachedbooleanແມ່ນແລ້ວ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…
errorstringແມ່ນແລ້ວ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_codestringແມ່ນແລ້ວ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_atstringແມ່ນແລ້ວ
finished_atstringບໍ່
resultSiteVitalsບໍ່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_todayobjectແມ່ນແລ້ວ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