seo-connect
POST /v1/seo-connection/index-checks
Check whether pages of the site are in Google's index. Spends credits.
Authentication
Send an API key as a bearer token. The endpoint checks sites.create; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/seo-connection/index-checks \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "urls": <string[]> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Up to 1,000 addresses on the connected site per call (more is more calls), duplicates checked once. Needs the seo.spend scope. The price of every page is debited up front (index_check in getSeoAccount) and the check runs in the background: read the outcome with getSeoIndexCheck. A page Google's index could not be asked about is indexed: null — unknown, never "not indexed" — and is refunded, so the site pays only for answers. Refused before anything is spent: an address on another host (422), no or too many addresses (422), not enough credit, the site's monthly limit or an account not in good standing (403).
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
urls | string[] | Yes | Addresses on the connected site; a scheme-less one is read as https://. At most 1,000 distinct addresses. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
status | string<queued, complete, failed> | Yes | — |
urls | integer | Yes | — |
indexed | integer | Yes | — |
not_indexed | integer | Yes | — |
unknown | integer | Yes | Pages the index could not be asked about — refunded. |
results | object[] | Yes | — |
price_micros | integer | Yes | Price per page |
charged_micros | integer | Yes | Debited up front. |
refunded_micros | integer | Yes | Returned for unanswered pages. |
currency | string<USD> | Yes | — |
created_at | string | Yes | — |
finished_at | object | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 503