hosting
GET /v1/wordpress/overview
Count the caller's whole WordPress estate by posture.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.
حيث يتم إدخال معرف مؤسستك
تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.
معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X GET https://api.zinndigital.com/v1/wordpress/overview \
-H "Authorization: Bearer zdk_live_…"هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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