domains
GET /v1/domains/{domainId}/index-check
Get a domain's search-index status.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/index-check \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
The cached search-index reading for this domain — whether Google has the site, and roughly how much of it. Included on every Footprint-Free plan. This never calls the upstream provider, so it is free to render and poll. Use the run endpoint to perform a new check; each check consumes provider allowance. state distinguishes four cases that must not be conflated: indexed, not_indexed (the provider answered and the search engine has nothing — a real measurement worth acting on), unknown (the provider could not tell us — an outage on our side, not a statement about the site) and never_checked (nothing has been requested yet). A client that renders unknown the same way as not_indexed will report healthy sites as deindexed during any provider outage. estimated_indexed_pages is the search engine's own loose upper bound and is not an authoritative page count — it routinely differs from Search Console by several times. Present it as a trend, never as "N pages indexed".
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
domainId (path) | Uuid | Да | The domain's id. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429