Get workflow aggregations

Server: https://{kibana_url}

GET /api/workflows/aggs
GET /s/{space_id}/api/workflows/aggs

Refer to Spaces for more information.

Retrieve distinct values and their counts for the specified workflow fields. Useful for building filters such as lists of tags or creators.

[Required authorization] Route required privileges: workflowsManagement:read OR workflowsManagement:managed:read.

Query Parameters

Response

200

Indicates a successful response

application/json

Examples

Example response with tag and createdBy aggregations

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/workflows/aggs?fields=tags&fields=createdBy

curl Shell

curl \
  -X GET "${KIBANA_URL}/api/workflows/aggs?fields=tags&fields=createdBy" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

{
  "createdBy": [
    {
      "doc_count": 2,
      "key": "elastic"
    }
  ],
  "tags": [
    {
      "doc_count": 1,
      "key": "reporting"
    },
    {
      "doc_count": 1,
      "key": "security"
    },
    {
      "doc_count": 1,
      "key": "triage"
    }
  ]
}

Query Parameters { fields , managed , }

Response

Query Parameters