board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Unde merge ID-ul organizației tale
Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
org_id (query) | string | Nu | Required only when the caller holds the permission in several orgs. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
links_total | integer | Nu | — |
links_never_synced | integer | Nu | — |
links_failing | integer | Nu | — |
coverage_is_complete | boolean | Nu | 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 | Nu | — |
items_open | integer | Nu | — |
items_archived | integer | Nu | — |
items_unassigned | integer | Nu | — |
items_no_status | integer | Nu | — |
overdue | integer | Nu | — |
stale | integer | Nu | — |
due_next_7_days | integer | Nu | — |
by_status | GitHubProjectStatusCount[] | Nu | — |
per_project | object[] | Nu | — |
Erori pe care le poate returna acest punct final
401 · 403 · 422