board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/board-github/rollup \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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