domains
GET /v1/domains/{domainId}/index-check
Get a domain's search-index status.
تصدیقهویت
د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/index-check \
-H "Authorization: Bearer zdk_live_…"ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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. |
تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي
401 · 403 · 404 · 429