board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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"*.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id (query) | string | Ні | Required only when the caller holds the permission in several orgs. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
links_total | integer | Ні | — |
links_never_synced | integer | Ні | — |
links_failing | integer | Ні | — |
coverage_is_complete | boolean | Ні | 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 | Ні | — |
items_open | integer | Ні | — |
items_archived | integer | Ні | — |
items_unassigned | integer | Ні | — |
items_no_status | integer | Ні | — |
overdue | integer | Ні | — |
stale | integer | Ні | — |
due_next_7_days | integer | Ні | — |
by_status | GitHubProjectStatusCount[] | Ні | — |
per_project | object[] | Ні | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 422