hosting
GET /v1/sites/{siteId}/index-check
A hosted site's search-index status.
Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/index-check \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
siteId (path) | Uuid | Ya | Site ID (UUIDv7). |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
fqdn | string | Ya | — |
state | string<indexed, not_indexed, unknown, never_checked> | Ya | `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_at | string | Tidak | When the stored check ran. Null when never checked. |
is_stale | boolean | Ya | 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_pages | integer | Tidak | 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_urls | string[] | Tidak | 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_at | string | Tidak | When this domain is next due for an automatic check. Indexed sites are re-checked monthly, missing ones daily, and unknown ones within hours. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404