board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Kung saan mapupunta ang id ng iyong organisasyon
Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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"*.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
org_id (query) | string | Hindi | Required only when the caller holds the permission in several orgs. |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
links_total | integer | Hindi | — |
links_never_synced | integer | Hindi | — |
links_failing | integer | Hindi | — |
coverage_is_complete | boolean | Hindi | 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 | Hindi | — |
items_open | integer | Hindi | — |
items_archived | integer | Hindi | — |
items_unassigned | integer | Hindi | — |
items_no_status | integer | Hindi | — |
overdue | integer | Hindi | — |
stale | integer | Hindi | — |
due_next_7_days | integer | Hindi | — |
by_status | GitHubProjectStatusCount[] | Hindi | — |
per_project | object[] | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 422