hosting
GET /v1/sites/{siteId}/index-check
A hosted site's search-index status.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/index-check \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у 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). |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
fqdn | string | Да | — |
state | string<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… |
checked_at | string | Не | When the stored check ran. Null when never checked. |
is_stale | boolean | Да | 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 | Не | 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… |
sample_urls | string[] | Не | 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 | Не | 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