board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
認証
ベアラー トークンとして 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