Incidents service

List incident events with filters

List incident events with support for filtering, pagination, and ordering. This operation accepts a page size of at most 1000 (it defaults to 100 when pageSize is omitted) and rejects larger values, even though the shared pagination schema documents a maximum of 10000.

Requires the following permissions:

  • incidents:read
get/incidents/events/v1

Request

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

Query parameters

contextualLabelsobject

The contextual labels of the incident

displayLabelsobject

The display labels of the incident

isMutedboolean

Indicates if the incident is muted

namestring

The name of the incident

severityIncidentSeverity[]

The severity of the incident

statusIncidentStatus[]

The status of the incident

Filter for incident events

{
  "labels": {
    "metaLabels": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  }
}
pageSizeinteger required

Number of items to return per page.

pageTokenstring

Token for the next page of results

Pagination parameters. This request accepts at most 1000 items per page, and defaults to 100 when pageSize is omitted; the shared maximum of 10000 does not apply here.

{
  "pageSize": 10,
  "pageToken": "next_page_token"
}
direction'ORDER_BY_DIRECTION_UNSPECIFIED' | 'ORDER_BY_DIRECTION_ASC' | 'ORDER_BY_DIRECTION_DESC'

Order by direction.

field'INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED'

Incident event order by field type.

Order by fields for incident events

Response

Example response

{
  "items": [
    {
      "incidentEvent": {
        "acknowledge": {
          "acknowledgedBy": {
            "userId": "user_id"
          }
        },
        "assignment": {
          "assignment": {
            "assignedBy": {
              "userId": "user_id"
            },
            "assignedTo": {
              "userId": "user_id"
            }
          }
        },
        "close": {
          "closedBy": {
            "userId": "user_id"
          }
        },
        "id": "incident_event_id"
      },
      "incidentEventExtendedMetadata": {
        "alertLabels": [
          {
            "key": "key",
            "value": "value"
          }
        ]
      }
    }
  ],
  "pagination": {
    "nextPageToken": "next_page_token",
    "totalSize": 100
  }
}

Changes

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