Skip to main content
GET
/
v1
/
dashboards
/
workflows
/
summary
Get Dashboard Workflow Summary
curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/dashboards/workflows/summary \
  --header 'X-API-Key: <api-key>'
{
  "total": 15,
  "active": 8,
  "byStatus": [
    {
      "status": "active",
      "count": 8
    }
  ]
}

Authorizations

X-API-Key
string
header
required

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Response

Indicates that the request was successful and the response contains the requested data.

Aggregated summary of all workflows grouped by status.

total
integer

Total number of workflows.

Example:

15

active
integer

Number of currently active workflows.

Example:

8

byStatus
object[]

Breakdown of workflows by status.