Get workflow aggregations

Base URL: 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

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

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

Example response with tag and createdBy aggregations

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