board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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"*.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | string | Não | Required only when the caller holds the permission in several orgs. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
links_total | integer | Não | — |
links_never_synced | integer | Não | — |
links_failing | integer | Não | — |
coverage_is_complete | boolean | Não | 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 | Não | — |
items_open | integer | Não | — |
items_archived | integer | Não | — |
items_unassigned | integer | Não | — |
items_no_status | integer | Não | — |
overdue | integer | Não | — |
stale | integer | Não | — |
due_next_7_days | integer | Não | — |
by_status | GitHubProjectStatusCount[] | Não | — |
per_project | object[] | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 422