domains

GET /v1/domains/{domainId}/index-check

Get a domain's search-index status.

모든 domains 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/index-check \
  -H "Authorization: Bearer zdk_live_…"

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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)UuidThe domain's id.

응답

이름유형필수설명
fqdnstring
statestring<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_atstring아니요When the stored check ran. Null when never checked.
is_stalebooleanTrue 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_pagesinteger아니요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_urlsstring[]아니요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_atstring아니요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