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, за да можете да видите действителния отговор. Отворете този крайpoint в 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[] | Не | — |
Грешки, които този крайpoint може да върне
401 · 403 · 422