flows

Get the delivery report

Completion, effort remaining, workload per member, the tasks blocking the most work, and what is unestimated or orphaned. The same figures the Reporting view shows.

get/v1/flows/{flowId}/report

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/flows/{flowId}/report
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: flows:read)

Path parameters

flowIdstring required

Response

SUCCESS

flowIdstring required
flowNamestring
completionnumber required

0–1.

tasksTotalinteger required
tasksDoneinteger
tasksReadyinteger
tasksBlockedinteger
hoursEstimatednumber nullable
hoursRemainingnumber nullable
unestimatedTasksstring[]

Task ids with no estimate — the reason a projection is soft.

orphanedTasksstring[]

Tasks nothing depends on and that depend on nothing.

Changes

No recorded changes to this operation across all 1 revision of this API.