board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Նույնականացում
Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:
Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն
Այs վերջնակետը ընդունում է org_id-ը որպես հարցման պարամետր: Բաց թողեք այն, և կանչը կընդգրկի ձեր ամբողջ վարձակալության ենթածառը. ուղարկեք այն՝ կանչը մեկ կազմակերպության վրա սահմանափակելու համար:
Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
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