Incidents service

Get incident aggregations

Retrieve aggregated incident data with support for grouping and filtering.

Requires the following permissions:

  • incidents:read
get/incidents/aggregations/v1

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/incidents/aggregations/v1
  • Auth: API key in header Authorization

Query parameters

applicationNamestring[]

Filter by application names

assigneestring[]

Filter by assignee

contextualLabelsobject

Filter by contextual labels

displayLabelsobject

Filter by display labels

endTimestring date-time

Filters all incidents that were open in the given timeframe end time (deprecated, use incident_open_range instead)

isMutedboolean

Indicates if the incident is muted

metaLabelsOp'FILTER_OPERATOR_OR_OR_UNSPECIFIED' | 'FILTER_OPERATOR_AND'

Filter operator.

severityIncidentSeverity[]

Filter by incident severity

startTimestring date-time

Filters all incidents that were open in the given timeframe start time (deprecated, use incident_open_range instead)

stateIncidentState[]

Filter by incident state

statusIncidentStatus[]

Filter by incident status

subsystemNamestring[]

Filter by subsystem names

Filter for incidents

{
  "metaLabels": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "searchQuery": {
    "query": "error"
  }
}
pageSizeinteger required

Number of items to return per page.

pageTokenstring

Token for the next page of results

Pagination parameters

{
  "pageSize": 10,
  "pageToken": "next_page_token"
}

Response

Example response

{
  "incidentAggs": [
    {
      "aggAssignmentsCount": [
        {
          "assignedTo": {
            "userId": "user_id"
          },
          "count": 10
        }
      ],
      "aggMetaLabelsCount": [
        {
          "count": 10,
          "metaLabel": {
            "key": "key",
            "value": "value"
          }
        }
      ],
      "aggSeverityCount": [
        {
          "count": 10
        }
      ],
      "aggStateCount": [
        {
          "count": 10
        }
      ],
      "aggStatusCount": [
        {
          "count": 10
        }
      ],
      "groupBysValue": [
        {
          "contextualLabels": {
            "fieldName": "field_name",
            "fieldValue": "field_value"
          }
        }
      ]
    }
  ],
  "pagination": {
    "nextPageToken": "next_page_token",
    "totalSize": 100
  }
}

Changes

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