board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
조직 ID가 들어가는 위치
이 엔드포인트는 org_id을(를) 쿼리 매개변수로 사용합니다. 생략하면 테넌트 하위 트리 전체가 호출 대상이 되며, 값을 전달하면 특정 조직으로 호출 범위를 좁힐 수 있습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
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"*.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
org_id (query) | string | 아니요 | Required only when the caller holds the permission in several orgs. |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
links_total | integer | 아니요 | — |
links_never_synced | integer | 아니요 | — |
links_failing | integer | 아니요 | — |
coverage_is_complete | boolean | 아니요 | 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 | 아니요 | — |
items_open | integer | 아니요 | — |
items_archived | integer | 아니요 | — |
items_unassigned | integer | 아니요 | — |
items_no_status | integer | 아니요 | — |
overdue | integer | 아니요 | — |
stale | integer | 아니요 | — |
due_next_7_days | integer | 아니요 | — |
by_status | GitHubProjectStatusCount[] | 아니요 | — |
per_project | object[] | 아니요 | — |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 422