domains
GET /v1/domains/{domainId}/index-check
Get a domain's search-index status.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/index-check \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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".
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
domainId (path) | Uuid | Bəli | The domain's id. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
fqdn | string | Bəli | — |
state | string<indexed, not_indexed, unknown, never_checked> | Bəli | 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 | Xeyr | When the stored check ran. Null when never checked. |
is_stale | boolean | Bəli | 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 | Xeyr | 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[] | Xeyr | 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 | Xeyr | When this domain is next due for an automatic check. Indexed sites are re-checked monthly, missing ones daily, and unknown ones within hours. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 429