board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.
Nơi điền id tổ chức của bạn
Điểm cuối này nhận org_id làm tham số truy vấn. Hãy bỏ trống để áp dụng cho toàn bộ cây thuê của bạn; hoặc truyền giá trị vào để thu hẹp phạm vi gọi về một tổ chức duy nhất.
Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
GitHub shows one project at a time; this is the screen that does not exist there. An agency running four client projects gets one answer to *"how much is in progress and how much is late"*. `links_never_synced`, `links_failing` and `coverage_is_complete` are part of the answer, not diagnostics. A roll-up that silently omitted a project which failed to sync would be a number somebody makes a staffing decision on, and *"nothing is late"* must never render the same as *"I cannot see whether anything is late"*.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
org_id (query) | string | Không | Required only when the caller holds the permission in several orgs. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
links_total | integer | Không | — |
links_never_synced | integer | Không | — |
links_failing | integer | Không | — |
coverage_is_complete | boolean | Không | Whether the counts describe every connected project. Named as a question about COVERAGE rather than health: a project that has never synced is not unhealthy, it is unmeasured, a… |
items_total | integer | Không | — |
items_open | integer | Không | — |
items_archived | integer | Không | — |
items_unassigned | integer | Không | — |
items_no_status | integer | Không | — |
overdue | integer | Không | — |
stale | integer | Không | — |
due_next_7_days | integer | Không | — |
by_status | GitHubProjectStatusCount[] | Không | — |
per_project | object[] | Không | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 422