hosting

GET /v1/sites/{siteId}/index-check

A hosted site's search-index status.

ټول hosting پای ټکي

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

The **cached** search-index reading for this site's primary domain, in the same shape as the domain endpoint — it is the same underlying reading, reached from the site. ⛔⛔ **This is the only door most customers have.** The reading is keyed by FQDN and a hosted site has one, so it was always expressible; until this endpoint existed the only way to reach it was `GET /v1/domains/{domainId}/index-check`, which requires a `Domain` row. A Footprint-Free customer who registers their names elsewhere and connects nothing has no such row, so the status of their sites was unreachable from anywhere in the product. Never calls the upstream provider, so it is free to render. `state` distinguishes the same four cases the domain endpoint documents, and `unknown` must not be rendered like `not_indexed` — a client that conflates them reports healthy sites as deindexed during any provider outage. ⛔ There is deliberately **no** run counterpart on a site. Each check spends provider allowance, and a refresh button on every site across a large estate is an unbounded cost; freshness comes from the scheduled sweep. To force a check for one specific name, use the domain research tool, where the spend is metered against your own allowance.

پارامترونه

نومډولاړیندا څه شی دی
siteId (path)UuidهوSite ID (UUIDv7).

ځواب

نومډولاړیندا څه شی دی
fqdnstringهو
statestring<indexed, not_indexed, unknown, never_checked>هو`indexed` — the provider answered and the search engine has this site. `not_indexed` — the provider answered and the search engine has nothing. A real measurement, and the one s…
checked_atstringنهWhen the stored check ran. Null when never checked.
is_stalebooleanهوTrue when the reading is older than the 7-day monitoring window, or absent entirely. A hint that a fresh check is worth its allowance — not an indication the result is wrong.
estimated_indexed_pagesintegerنهThe search engine's own loose upper bound for how many pages of this site it holds. **An estimate, not an authoritative count** — it routinely differs from Search Console by sev…
sample_urlsstring[]نهA few URLs the search engine returned, so a customer can confirm the right site was matched. Evidence, not a sitemap — capped at five.
next_check_atstringنهWhen this domain is next due for an automatic check. Indexed sites are re-checked monthly, missing ones daily, and unknown ones within hours.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404