board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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"*.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | string | Ne | Required only when the caller holds the permission in several orgs. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
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 | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422