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 कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को 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 s… |
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 sev… |
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