board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
您的组织 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