hosting
GET /v1/wordpress/overview
Count the caller's whole WordPress estate by posture.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/wordpress/overview \
-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
The manager's tiles, counted over every site in scope rather than over the current page. ⛔ A tile derived from one page would read "3 sites need attention" and mean "3 on this page", which is the reading a customer will not make. never_collected is reported separately from unknown on purpose: the first is "nobody has ever asked this site", the second also covers "we asked and the platform declined to say". Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | Narrow to one organisation in the caller's subtree. Equivalent to the X-Zinn-Org header, which is now read centrally for every org-scoped operation — this parameter wins where… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
total | integer | Yes | — |
installed | integer | Yes | — |
core_updates | integer | Yes | — |
component_updates | integer | Yes | — |
current | integer | Yes | — |
unknown | integer | Yes | — |
not_installed | integer | Yes | — |
unreachable | integer | Yes | Sites whose homepage answered 4xx/5xx, or did not answer at all. |
never_collected | integer | Yes | Sites nobody has ever asked. Reported separately from unknown, which also covers "we asked and the platform declined to say". |
healthy | integer | Yes | Sites assessed, with no critical finding. |
unhealthy | integer | Yes | Sites assessed, with at least one critical finding. |
health_unknown | integer | Yes | ⛔⛔ Sites we have not assessed, and the counter that makes the other two honest. healthy + unhealthy + health_unknown == total, always. Without it an estate nobody had ever… |
by_deploy_target | object | Yes | — |
by_product_line | object | Yes | — |
Errors this endpoint can return
401 · 403 · 429