การยืนยันตัวตน

ส่ง 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 ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง 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…

การตอบกลับ

ชื่อประเภทจำเป็นต้องมีลักษณะของสิ่งนี้
totalintegerใช่
installedintegerใช่
core_updatesintegerใช่
component_updatesintegerใช่
currentintegerใช่
unknownintegerใช่
not_installedintegerใช่
unreachableintegerใช่Sites whose homepage answered 4xx/5xx, or did not answer at all.
never_collectedintegerใช่Sites nobody has ever asked. Reported separately from unknown, which also covers "we asked and the platform declined to say".
healthyintegerใช่Sites assessed, with no critical finding.
unhealthyintegerใช่Sites assessed, with at least one critical finding.
health_unknownintegerใช่⛔⛔ 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_targetobjectใช่
by_product_lineobjectใช่

ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้

401 · 403 · 429