Get available filter values

Retrieve available filter and aggregation values for cases.

Requires the following permissions:

• case:Read

Get available filter values

cURL

curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/cases/filter-values/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "alertFilters": {
      "alertIds": [
        "f56645c5-9cd4-4b9f-961f-4f852d8835a0",
        "a0a08c31-0ae4-4600-928e-cb6b7da50a99"
      ],
      "alertVersions": [
        "550e8400-e29b-41d4-a716-446655440000",
        "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
      ]
    },
    "assignees": [
      {
        "unassigned": {}
      }
    ],
    "breached": [
      "KPI_FILTER_NOT_BREACHED"
    ],
    "caseLabelsFilter": {
      "flatLabels": [
        {
          "key": "region",
          "value": "us-west-1"
        }
      ]
    },
    "categories": [
      "CASE_CATEGORY_SECURITY",
      "CASE_CATEGORY_AVAILABILITY"
    ],
    "connectorTypeFilters": [
      {
        "connector_type": "CONNECTOR_TYPE_SLACK"
      },
      {
        "no_connector": {}
      }
    ],
    "groupings": [
      {
        "key": "service",
        "values": [
          "payments",
          "auth"
        ]
      }
    ],
    "impactedEntities": [
      {
        "apmService": {
          "name": "payments-api"
        }
      },
      {
        "apmDatabase": {
          "name": "orders-db"
        }
      }
    ],
    "indicatorTypes": [],
    "labels": [
      {
        "key": "team",
        "values": [
          "backend"
        ]
      }
    ],
    "priorities": [
      "CASE_PRIORITY_P1",
      "CASE_PRIORITY_P2"
    ],
    "statuses": [],
    "textSearch": "Vulnerability"
  }
}
'

200

{
  "alertIdAggregations": [
    {
      "alertId": "f56645c5-9cd4-4b9f-961f-4f852d8835a0",
      "count": 5
    }
  ],
  "categoryAggregations": [
    {
      "category": "CASE_CATEGORY_UNSPECIFIED",
      "count": 13
    }
  ],
  "flatLabelsAggregation": [
    {
      "count": 500000000,
      "filter": {
        "key": "service",
        "value": "payments"
      }
    }
  ],
  "groupingAggregations": [
    {
      "valueCounts": [
        {
          "count": 8,
          "value": "service:payments"
        }
      ],
      "key": "service"
    }
  ],
  "labelAggregations": [
    {
      "valueCounts": [
        {
          "count": 8,
          "value": "service:payments"
        }
      ],
      "key": "service"
    }
  ],
  "priorityAggregations": [
    {
      "count": 17,
      "priority": "CASE_PRIORITY_UNSPECIFIED"
    }
  ],
  "statusAggregations": [
    {
      "count": 500000000,
      "status": "CASE_STATUS_UNSPECIFIED"
    }
  ],
  "assigneeAggregations": {
    "assignedCounts": [
      {
        "assignee": "<string>",
        "count": 500000000
      }
    ],
    "unassignedCount": 500000000
  }
}

Authorizations

Authorization · string · header · required

API key authentication

Body

application/json

Request to retrieve available filter and aggregation values for cases.

filters · Case filters · object

Filters to apply when computing available values

Show child attributes

Response

200

application/json

Aggregated counts for building filters in the UI

alertIdAggregations · Alert ID aggregation · object[] · required

Aggregated case counts per alert definition ID. Only populated when alert_filters is provided in the request.

Maximum array length: 1000

Show child attributes

categoryAggregations · Category aggregation · object[] · required

Aggregated case counts grouped by category.

Maximum array length: 1000

Show child attributes

flatLabelsAggregation · Filter aggregation · object[] · required

Aggregated case counts grouped by individual flat label key/value pairs.

Maximum array length: 1000

Show child attributes

groupingAggregations · Filter group aggregation · object[] · required

Aggregated case counts grouped by grouping key/value pairs.

Maximum array length: 1000

Show child attributes

labelAggregations · Filter group aggregation · object[] · required

Aggregated case counts grouped by label key/value pairs.

Maximum array length: 1000

Show child attributes

priorityAggregations · Priority aggregation · object[] · required

Aggregated case counts grouped by priority.

Maximum array length: 1000

Show child attributes

statusAggregations · Status aggregation · object[] · required

Aggregated case counts grouped by status.

Maximum array length: 1000

Show child attributes

assigneeAggregations · Assignee aggregation · object

Aggregated case counts grouped by assignee.

Show child attributes