board-github

GET /v1/board-github/rollup

Every linked GitHub Project, summed into one view.

所有 board-github 端点

身份验证

请将 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)stringRequired only when the caller holds the permission in several orgs.

响应

名称类型必填内容简介
links_totalinteger
links_never_syncedinteger
links_failinginteger
coverage_is_completebooleanWhether 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_totalinteger
items_openinteger
items_archivedinteger
items_unassignedinteger
items_no_statusinteger
overdueinteger
staleinteger
due_next_7_daysinteger
by_statusGitHubProjectStatusCount[]
per_projectobject[]

此端点可能返回的错误

401 · 403 · 422