hosting
GET /v1/wordpress/overview
Count the caller's whole WordPress estate by posture.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/wordpress/overview \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id (query) | string | Non | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
total | integer | Oui | — |
installed | integer | Oui | — |
core_updates | integer | Oui | — |
component_updates | integer | Oui | — |
current | integer | Oui | — |
unknown | integer | Oui | — |
not_installed | integer | Oui | — |
unreachable | integer | Oui | Sites whose homepage answered 4xx/5xx, or did not answer at all. |
never_collected | integer | Oui | Sites nobody has ever asked. Reported separately from `unknown`, which also covers *"we asked and the platform declined to say"*. |
healthy | integer | Oui | Sites assessed, with no critical finding. |
unhealthy | integer | Oui | Sites assessed, with at least one critical finding. |
health_unknown | integer | Oui | ⛔⛔ **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 | Oui | — |
by_product_line | object | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 429