hosting
GET /v1/wordpress/overview
Count the caller's whole WordPress estate by posture.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/wordpress/overview \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | string | いいえ | 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… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
total | integer | はい | — |
installed | integer | はい | — |
core_updates | integer | はい | — |
component_updates | integer | はい | — |
current | integer | はい | — |
unknown | integer | はい | — |
not_installed | integer | はい | — |
unreachable | integer | はい | Sites whose homepage answered 4xx/5xx, or did not answer at all. |
never_collected | integer | はい | Sites nobody has ever asked. Reported separately from `unknown`, which also covers *"we asked and the platform declined to say"*. |
healthy | integer | はい | Sites assessed, with no critical finding. |
unhealthy | integer | はい | Sites assessed, with at least one critical finding. |
health_unknown | integer | はい | ⛔⛔ **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 | はい | — |
by_product_line | object | はい | — |
このエンドポイントが返すエラー
401 · 403 · 429