board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Autentifikacija
Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.
Gdje dolazi ID vaše organizacije
Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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"*.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
org_id (query) | string | Ne | Required only when the caller holds the permission in several orgs. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
links_total | integer | Ne | — |
links_never_synced | integer | Ne | — |
links_failing | integer | Ne | — |
coverage_is_complete | boolean | Ne | 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 | Ne | — |
items_open | integer | Ne | — |
items_archived | integer | Ne | — |
items_unassigned | integer | Ne | — |
items_no_status | integer | Ne | — |
overdue | integer | Ne | — |
stale | integer | Ne | — |
due_next_7_days | integer | Ne | — |
by_status | GitHubProjectStatusCount[] | Ne | — |
per_project | object[] | Ne | — |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 422