board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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"*.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
org_id (query) | string | Tidak | Required only when the caller holds the permission in several orgs. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
links_total | integer | Tidak | — |
links_never_synced | integer | Tidak | — |
links_failing | integer | Tidak | — |
coverage_is_complete | boolean | Tidak | 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 | Tidak | — |
items_open | integer | Tidak | — |
items_archived | integer | Tidak | — |
items_unassigned | integer | Tidak | — |
items_no_status | integer | Tidak | — |
overdue | integer | Tidak | — |
stale | integer | Tidak | — |
due_next_7_days | integer | Tidak | — |
by_status | GitHubProjectStatusCount[] | Tidak | — |
per_project | object[] | Tidak | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 422