board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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"*.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
org_id (query) | string | Nee | Required only when the caller holds the permission in several orgs. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
links_total | integer | Nee | — |
links_never_synced | integer | Nee | — |
links_failing | integer | Nee | — |
coverage_is_complete | boolean | Nee | 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 | Nee | — |
items_open | integer | Nee | — |
items_archived | integer | Nee | — |
items_unassigned | integer | Nee | — |
items_no_status | integer | Nee | — |
overdue | integer | Nee | — |
stale | integer | Nee | — |
due_next_7_days | integer | Nee | — |
by_status | GitHubProjectStatusCount[] | Nee | — |
per_project | object[] | Nee | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 422