domains
GET /v1/domains/{domainId}/index-check
Get a domain's search-index status.
การยืนยันตัวตน
ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
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