Reports
The same aggregates the in-app dashboards render — throughput, cycle time, lead time, burndown, velocity, aging, distribution and time logged.
Scope: reports:read (read-only — there is no reports:write)
Nine endpoints, all GET, all returning the aggregate the equivalent in-app
chart draws. They exist so a workspace can put its own numbers into a BI tool
without re-implementing the definitions — and getting them subtly different.
| Endpoint | Answers |
|---|---|
/reports/summary/ | The headline counts for a project or the workspace |
/reports/throughput/ | How many tasks completed per period |
/reports/cycle-time/ | How long tasks take from start to done |
/reports/lead-time/ | How long from created to done |
/reports/velocity/ | Completed work per sprint |
/reports/burndown/ | Remaining work over a sprint or milestone |
/reports/aging/ | How long open work has been sitting |
/reports/distribution/ | Breakdown by status, assignee, type or priority |
/reports/time-logged/ | Time entries, aggregated |
The definitions are the point
Cycle time and lead time are not the same measurement, and throughput is not velocity. Krrim computes them one way, in one place, and these endpoints return that computation.
If you re-derive a metric from the task list instead of reading it here, your dashboard and the in-app report will eventually disagree — and the argument about which is right is more expensive than the API call.
Common parameters
Most reports accept a project and a window:
GET /api/v1/reports/throughput/?project=12&from=2026-07-01&to=2026-07-31Omitting the project aggregates across everything the service account can see, which is not the same as everything in the workspace. A report token scoped to one project reports on one project.
Endpoints
| Method | Path | Scope |
|---|---|---|
GET | /api/v1/reports/aging/ | reports:read |
GET | /api/v1/reports/burndown/ | reports:read |
GET | /api/v1/reports/cycle-time/ | reports:read |
GET | /api/v1/reports/distribution/ | reports:read |
GET | /api/v1/reports/lead-time/ | reports:read |
GET | /api/v1/reports/summary/ | reports:read |
GET | /api/v1/reports/throughput/ | reports:read |
GET | /api/v1/reports/time-logged/ | reports:read |
GET | /api/v1/reports/velocity/ | reports:read |