board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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"*.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
org_id (query) | string | Xeyr | Required only when the caller holds the permission in several orgs. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
links_total | integer | Xeyr | — |
links_never_synced | integer | Xeyr | — |
links_failing | integer | Xeyr | — |
coverage_is_complete | boolean | Xeyr | 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 | Xeyr | — |
items_open | integer | Xeyr | — |
items_archived | integer | Xeyr | — |
items_unassigned | integer | Xeyr | — |
items_no_status | integer | Xeyr | — |
overdue | integer | Xeyr | — |
stale | integer | Xeyr | — |
due_next_7_days | integer | Xeyr | — |
by_status | GitHubProjectStatusCount[] | Xeyr | — |
per_project | object[] | Xeyr | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 422