hosting
GET /v1/index-monitoring
What this organisation monitors for search indexing, and what it may add.
Authentication
Send an API key as a bearer token. The endpoint checks sites.view; 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 GET https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…"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
Both paid indexing allowances, and every target being monitored, in one call. There are three indexing positions and only two of them have a row here. A site hosted with us has its whole-site check included free on every plan and appears in no list — that is what makes it free rather than discounted, and it is why sections.used can be 0 on an account that is checking fifty sites. A section target is a page or path prefix within a site, on top of that free check. An external_site target is a whole website hosted somewhere else, billed monthly per site. ⛔ Each allowance is returned with its denominator as well as its remainder. A bare "3 remaining" reads identically on an account with an allowance of 3 and nothing used, and on one with an allowance of 100 — and a client that renders only the remainder cannot tell a customer whether buying more would help. ⛔ indexed on a target is three-valued. false means the provider answered and does not list the page; null means no reading exists yet, or the row is beyond the current allowance and the sweep is not checking it. A client that renders null as false reports a customer's pages as deindexed on the morning their card expires. monitored is the field that says which of those two a null is. Never calls the upstream provider, so it is free to render and poll.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
daily | boolean | Yes | Checks run daily rather than weekly. |
daily_from_plan | boolean | Yes | The daily cadence came from the plan rather than a standalone add-on. ⭐ An upsell surface reads this to say "included in your plan" instead of offering to sell something the… |
sections | IndexMonitoringAllowance | Yes | One counted allowance, always with its denominator. ⛔ remaining alone is not renderable: it reads the same on an allowance of 3 with nothing used as on an allowance of 100 with… |
external_sites | IndexMonitoringAllowance | Yes | One counted allowance, always with its denominator. ⛔ remaining alone is not renderable: it reads the same on an allowance of 3 with nothing used as on an allowance of 100 with… |
targets | IndexMonitoringTarget[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404