board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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"*.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
org_id (query) | string | Hayır | Required only when the caller holds the permission in several orgs. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
links_total | integer | Hayır | — |
links_never_synced | integer | Hayır | — |
links_failing | integer | Hayır | — |
coverage_is_complete | boolean | Hayır | 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 | Hayır | — |
items_open | integer | Hayır | — |
items_archived | integer | Hayır | — |
items_unassigned | integer | Hayır | — |
items_no_status | integer | Hayır | — |
overdue | integer | Hayır | — |
stale | integer | Hayır | — |
due_next_7_days | integer | Hayır | — |
by_status | GitHubProjectStatusCount[] | Hayır | — |
per_project | object[] | Hayır | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 422