board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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, and… |
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