hosting
GET /v1/wordpress/overview
Count the caller's whole WordPress estate by posture.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/wordpress/overview \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | string | Não | 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… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
total | integer | Sim | — |
installed | integer | Sim | — |
core_updates | integer | Sim | — |
component_updates | integer | Sim | — |
current | integer | Sim | — |
unknown | integer | Sim | — |
not_installed | integer | Sim | — |
unreachable | integer | Sim | Sites whose homepage answered 4xx/5xx, or did not answer at all. |
never_collected | integer | Sim | Sites nobody has ever asked. Reported separately from `unknown`, which also covers *"we asked and the platform declined to say"*. |
healthy | integer | Sim | Sites assessed, with no critical finding. |
unhealthy | integer | Sim | Sites assessed, with at least one critical finding. |
health_unknown | integer | Sim | ⛔⛔ **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 | Sim | — |
by_product_line | object | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 429