List incidents with filters

Node.js

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/incidents';

let options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
  body: '{"filter":{"assignee":["string"],"status":["INCIDENT_STATUS_UNSPECIFIED"],"state":["INCIDENT_STATE_UNSPECIFIED"],"severity":["INCIDENT_SEVERITY_UNSPECIFIED"],"contextualLabels":{"property1":{"contextualLabelValues":["string"]},"property2":{"contextualLabelValues":["string"]}},"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z","searchQuery":{"query":"error","incidentField":"INCIDENTS_FIELDS_UNSPECIFIED","contextualLabel":"string"},"applicationName":["string"],"subsystemName":["string"],"isMuted":true,"createdAtRange":{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z"},"incidentDurationRange":{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z"},"metaLabels":[{"key":"key","value":"value"}],"metaLabelsOp":"FILTER_OPERATOR_OR_OR_UNSPECIFIED"},"pagination":{"pageSize":10,"pageToken":"next_page_token"},"orderBys":[{"incidentField":"INCIDENTS_FIELDS_UNSPECIFIED","contextualLabel":"string","direction":"ORDER_BY_DIRECTION_UNSPECIFIED"}]}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

{
  "incidents": [
    {
      "id": "incident_id",
      "state": "INCIDENT_STATE_UNSPECIFIED",
      "status": "INCIDENT_STATUS_UNSPECIFIED",
      "assignments": [
        {
          "assignedTo": {
            "userId": "user_id"
          },
          "assignedBy": {
            "userId": "user_id"
          }
        }
      ],
      "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
      "contextualLabels": {},
      "displayLabels": {},
      "events": [
        {
          "id": "incident_event_id",
          "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
          "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
          "snoozeIndicator": {
            "startTime": "2023-11-07T05:31:56Z",
            "durationMinutes": 123,
            "userId": "<string>"
          },
          "assignment": {
            "assignment": {
              "assignedTo": {
                "userId": "user_id"
              },
              "assignedBy": {
                "userId": "user_id"
              }
            }
          },
          "unassign": {},
          "upsertState": {
            "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
            "payload": {
              "cxEventKey": "<string>"
            },
            "isMuted": true
          },
          "acknowledge": {
            "acknowledgedBy": {
              "userId": "user_id"
            }
          },
          "close": {
            "closedBy": {
              "userId": "user_id"
            }
          },
          "administrativeEvent": {
            "userId": "<string>"
          },
          "operationalEvent": {
            "systemName": "<string>"
          }
        }
      ],
      "createdAt": "2024-01-01T00:00:00.000Z",
      "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
      "lastStateUpdateKey": "last_state_update_key",
      "duration": "<string>",
      "name": "incident_name",
      "description": "incident_description",
      "closedAt": "2024-01-01T00:00:00.000Z",
      "isMuted": false,
      "metaLabels": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ],
  "pagination": {
    "totalSize": 100,
    "nextPageToken": "next_page_token"
  }
}

Node.js

const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v1/incidents';

let options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
  body: '{"filter":{"assignee":["string"],"status":["INCIDENT_STATUS_UNSPECIFIED"],"state":["INCIDENT_STATE_UNSPECIFIED"],"severity":["INCIDENT_SEVERITY_UNSPECIFIED"],"contextualLabels":{"property1":{"contextualLabelValues":["string"]},"property2":{"contextualLabelValues":["string"]}},"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z","searchQuery":{"query":"error","incidentField":"INCIDENTS_FIELDS_UNSPECIFIED","contextualLabel":"string"},"applicationName":["string"],"subsystemName":["string"],"isMuted":true,"createdAtRange":{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z"},"incidentDurationRange":{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z"},"metaLabels":[{"key":"key","value":"value"}],"metaLabelsOp":"FILTER_OPERATOR_OR_OR_UNSPECIFIED"},"pagination":{"pageSize":10,"pageToken":"next_page_token"},"orderBys":[{"incidentField":"INCIDENTS_FIELDS_UNSPECIFIED","contextualLabel":"string","direction":"ORDER_BY_DIRECTION_UNSPECIFIED"}]}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

{
  "incidents": [
    {
      "id": "incident_id",
      "state": "INCIDENT_STATE_UNSPECIFIED",
      "status": "INCIDENT_STATUS_UNSPECIFIED",
      "assignments": [
        {
          "assignedTo": {
            "userId": "user_id"
          },
          "assignedBy": {
            "userId": "user_id"
          }
        }
      ],
      "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
      "contextualLabels": {},
      "displayLabels": {},
      "events": [
        {
          "id": "incident_event_id",
          "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
          "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
          "snoozeIndicator": {
            "startTime": "2023-11-07T05:31:56Z",
            "durationMinutes": 123,
            "userId": "<string>"
          },
          "assignment": {
            "assignment": {
              "assignedTo": {
                "userId": "user_id"
              },
              "assignedBy": {
                "userId": "user_id"
              }
            }
          },
          "unassign": {},
          "upsertState": {
            "stateType": "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED",
            "payload": {
              "cxEventKey": "<string>"
            },
            "isMuted": true
          },
          "acknowledge": {
            "acknowledgedBy": {
              "userId": "user_id"
            }
          },
          "close": {
            "closedBy": {
              "userId": "user_id"
            }
          },
          "administrativeEvent": {
            "userId": "<string>"
          },
          "operationalEvent": {
            "systemName": "<string>"
          }
        }
      ],
      "createdAt": "2024-01-01T00:00:00.000Z",
      "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
      "lastStateUpdateKey": "last_state_update_key",
      "duration": "<string>",
      "name": "incident_name",
      "description": "incident_description",
      "closedAt": "2024-01-01T00:00:00.000Z",
      "isMuted": false,
      "metaLabels": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ],
  "pagination": {
    "totalSize": 100,
    "nextPageToken": "next_page_token"
  }
}

Authorizations

Authorization

string

header

required

API key authentication

Body

application/json

Request to list incidents with filtering, pagination and ordering options

filter

Incident query filter · object

Filter configuration for incidents

Show child attributes

filter.assignee

string[]

Filter by assignee

filter.status

enum<string>[]

Filter by incident status

Available options:

INCIDENT_STATUS_UNSPECIFIED,

INCIDENT_STATUS_TRIGGERED,

INCIDENT_STATUS_ACKNOWLEDGED,

INCIDENT_STATUS_RESOLVED

filter.state

enum<string>[]

Filter by incident state

Available options:

INCIDENT_STATE_UNSPECIFIED,

INCIDENT_STATE_TRIGGERED,

INCIDENT_STATE_RESOLVED

filter.severity

enum<string>[]

Filter by incident severity

Available options:

INCIDENT_SEVERITY_UNSPECIFIED,

INCIDENT_SEVERITY_INFO,

INCIDENT_SEVERITY_WARNING,

INCIDENT_SEVERITY_ERROR,

INCIDENT_SEVERITY_CRITICAL,

INCIDENT_SEVERITY_LOW

filter.contextualLabels

object

Filter by contextual labels

Show child attributes

filter.contextualLabels.{key}

Contextual label values · object

Represents contextual label values for filtering incidents

Show child attributes

filter.contextualLabels.{key}.contextualLabelValues

string[]

required

filter.startTime

string<date-time>

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

filter.endTime

string<date-time>

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

filter.searchQuery

Incident search query · object

Show child attributes

filter.searchQuery.query

string

required

The search query

Example:

"error"

filter.searchQuery.incidentField

enum<string>

default:INCIDENTS_FIELDS_UNSPECIFIED

Available options:

INCIDENTS_FIELDS_UNSPECIFIED,

INCIDENTS_FIELDS_ID,

INCIDENTS_FIELDS_SEVERITY,

INCIDENTS_FIELDS_NAME,

INCIDENTS_FIELDS_CREATED_TIME,

INCIDENTS_FIELDS_CLOSED_TIME,

INCIDENTS_FIELDS_STATE,

INCIDENTS_FIELDS_STATUS,

INCIDENTS_FIELDS_LAST_STATE_UPDATE_TIME,

INCIDENTS_FIELDS_APPLICATION_NAME,

INCIDENTS_FIELDS_SUBSYSTEM_NAME,

INCIDENTS_FIELDS_DURATION

filter.searchQuery.contextualLabel

string

The contextual label to search in.

filter.applicationName

string[]

Filter by application names

filter.subsystemName

string[]

Filter by subsystem names

filter.isMuted

boolean

Indicates if the incident is muted

filter.createdAtRange

Time range · object

Represents a time range with start and end timestamps

Show child attributes

filter.createdAtRange.startTime

string<date-time>

required

Start time of the range

filter.createdAtRange.endTime

string<date-time>

required

End time of the range

filter.incidentDurationRange

Time range · object

Represents a time range with start and end timestamps

Show child attributes

filter.incidentDurationRange.startTime

string<date-time>

required

Start time of the range

filter.incidentDurationRange.endTime

string<date-time>

required

End time of the range

filter.metaLabels

Incident meta label · object[]

Filters all incidents with the given meta labels

Show child attributes

filter.metaLabels.key

string

Example:

"key"

filter.metaLabels.value

string

Example:

"value"

filter.metaLabelsOp

enum<string>

default:FILTER_OPERATOR_OR_OR_UNSPECIFIED

Available options:

FILTER_OPERATOR_OR_OR_UNSPECIFIED,

FILTER_OPERATOR_AND

pagination

Pagination request · object

Pagination parameters for list requests

Show child attributes

pagination.pageSize

integer<int64>

required

Number of items to return per page

Example:

10

pagination.pageToken

string

Token for the next page of results

Example:

"next_page_token"

orderBys

Incident order by · object[]

Order by fields

Show child attributes

orderBys.direction

enum<string>

default:ORDER_BY_DIRECTION_UNSPECIFIED

required

Available options:

ORDER_BY_DIRECTION_UNSPECIFIED,

ORDER_BY_DIRECTION_ASC,

ORDER_BY_DIRECTION_DESC

orderBys.incidentField

enum<string>

default:INCIDENTS_FIELDS_UNSPECIFIED

Available options:

INCIDENTS_FIELDS_UNSPECIFIED,

INCIDENTS_FIELDS_ID,

INCIDENTS_FIELDS_SEVERITY,

INCIDENTS_FIELDS_NAME,

INCIDENTS_FIELDS_CREATED_TIME,

INCIDENTS_FIELDS_CLOSED_TIME,

INCIDENTS_FIELDS_STATE,

INCIDENTS_FIELDS_STATUS,

INCIDENTS_FIELDS_LAST_STATE_UPDATE_TIME,

INCIDENTS_FIELDS_APPLICATION_NAME,

INCIDENTS_FIELDS_SUBSYSTEM_NAME,

INCIDENTS_FIELDS_DURATION

orderBys.contextualLabel

string

Response

A successful response.

Response containing a list of incidents and pagination information

incidents

Incident · object[]

required

Show child attributes

incidents.id

string

required

Example:

"incident_id"

incidents.state

enum<string>

default:INCIDENT_STATE_UNSPECIFIED

required

Available options:

INCIDENT_STATE_UNSPECIFIED,

INCIDENT_STATE_TRIGGERED,

INCIDENT_STATE_RESOLVED

incidents.status

enum<string>

default:INCIDENT_STATUS_UNSPECIFIED

required

Available options:

INCIDENT_STATUS_UNSPECIFIED,

INCIDENT_STATUS_TRIGGERED,

INCIDENT_STATUS_ACKNOWLEDGED,

INCIDENT_STATUS_RESOLVED

incidents.assignments

Assignment · object[]

required

Show child attributes

incidents.assignments.assignedTo

User details · object

required

Show child attributes

incidents.assignments.assignedTo.userId

string

required

Example:

"user_id"

incidents.assignments.assignedBy

User details · object

required

Show child attributes

incidents.assignments.assignedBy.userId

string

required

Example:

"user_id"

incidents.severity

enum<string>

default:INCIDENT_SEVERITY_UNSPECIFIED

required

Available options:

INCIDENT_SEVERITY_UNSPECIFIED,

INCIDENT_SEVERITY_INFO,

INCIDENT_SEVERITY_WARNING,

INCIDENT_SEVERITY_ERROR,

INCIDENT_SEVERITY_CRITICAL,

INCIDENT_SEVERITY_LOW

incidents.contextualLabels

object

required

The incident's current contextual labels - dynamic labels that give contextual information about the incident (for example, the alert_name label can appear in an incident created by an event originating from the alerting system).

Show child attributes

incidents.contextualLabels.{key}

string

incidents.displayLabels

The incident's current display labels - dynamic labels that extend the incident name for identification purposes · object

required

Show child attributes

incidents.displayLabels.{key}

string

incidents.events

Incident event · object[]

required

Show child attributes

incidents.events.id

string

required

The ID of the incident event

Example:

"incident_event_id"

incidents.events.incidentEventType

enum<string>

default:INCIDENT_EVENT_TYPE_UNSPECIFIED

required

Available options:

INCIDENT_EVENT_TYPE_UNSPECIFIED,

INCIDENT_EVENT_TYPE_UPSERT_STATE,

INCIDENT_EVENT_TYPE_OPEN,

INCIDENT_EVENT_TYPE_CLOSE,

INCIDENT_EVENT_TYPE_SNOOZE_INDICATOR,

INCIDENT_EVENT_TYPE_ASSIGN,

INCIDENT_EVENT_TYPE_UNASSIGN,

INCIDENT_EVENT_TYPE_ACKNOWLEDGE

incidents.events.originatorType

enum<string>

default:ORIGINATOR_TYPE_UNSPECIFIED

required

Available options:

ORIGINATOR_TYPE_UNSPECIFIED,

ORIGINATOR_TYPE_OPERATIONAL,

ORIGINATOR_TYPE_ADMINISTRATIVE

incidents.events.snoozeIndicator

Incident event snooze indicator · object

Show child attributes

incidents.events.snoozeIndicator.startTime

string<date-time>

incidents.events.snoozeIndicator.durationMinutes

integer<int32>

incidents.events.snoozeIndicator.userId

string

incidents.events.assignment

Incident event assignment details · object

Show child attributes

incidents.events.assignment.assignment

Assignment · object

Details of the user who assigned the incident and the user to whom it was assigned

Show child attributes

incidents.events.assignment.assignment.assignedTo

User details · object

required

Show child attributes

incidents.events.assignment.assignment.assignedTo.userId

string

required

Example:

"user_id"

incidents.events.assignment.assignment.assignedBy

User details · object

required

Show child attributes

incidents.events.assignment.assignment.assignedBy.userId

string

required

Example:

"user_id"

incidents.events.unassign

object

incidents.events.upsertState

Incident event upsert state · object

Show child attributes

incidents.events.upsertState.stateType

enum<string>

default:UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED

required

Available options:

UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED,

UPSERT_INCIDENT_STATE_TYPE_TRIGGERED,

UPSERT_INCIDENT_STATE_TYPE_RESOLVED

incidents.events.upsertState.payload

object

required

Show child attributes

incidents.events.upsertState.payload.cxEventKey

string

incidents.events.upsertState.isMuted

boolean

incidents.events.acknowledge

object

Show child attributes

incidents.events.acknowledge.acknowledgedBy

User details · object

Show child attributes

incidents.events.acknowledge.acknowledgedBy.userId

string

required

Example:

"user_id"

incidents.events.close

object

Show child attributes

incidents.events.close.closedBy

User details · object

Show child attributes

incidents.events.close.closedBy.userId

string

required

Example:

"user_id"

incidents.events.administrativeEvent

object

Show child attributes

incidents.events.administrativeEvent.userId

string

incidents.events.operationalEvent

object

Show child attributes

incidents.events.operationalEvent.systemName

string

incidents.createdAt

string<date-time>

required

Example:

"2024-01-01T00:00:00.000Z"

incidents.lastStateUpdateTime

string<date-time>

required

Example:

"2024-01-01T00:00:00.000Z"

incidents.lastStateUpdateKey

string

required

Example:

"last_state_update_key"

incidents.duration

string

required

incidents.name

string

Example:

"incident_name"

incidents.description

string

Example:

"incident_description"

incidents.closedAt

string<date-time>

Example:

"2024-01-01T00:00:00.000Z"

incidents.isMuted

boolean

Example:

false

incidents.metaLabels

Incident meta label · object[]

Show child attributes

incidents.metaLabels.key

string

Example:

"key"

incidents.metaLabels.value

string

Example:

"value"

pagination

Pagination response · object

required

Pagination information for list responses

Show child attributes

pagination.totalSize

integer<int64>

required

Total number of items available

Example:

100

pagination.nextPageToken

string

Token for the next page of results

Example:

"next_page_token"

List incident events with filters Remove incident user assignments

⌘I

Introduction

Use Cases

Actions Service

Alert Definitions Service

Alert Events Service

API Keys Service

Contextual Data Integration Service

Custom Enrichments Service

Dashboard Folders Service

Dashboard Service

Data Usage Service

Enrichments Service

Events Service

Events2Metrics Service

Extension Deployment Service

Extension Service

Extension Testing Service

Folders for Views

Incidents Service

Integration Service

Outgoing Webhooks Service

Policies Service

Recording Rules Service

Retentions Service

Rule Groups Service

SAML Configuration Service

Scopes Service

Slos Service

Target Service

Team Permissions Management Service

Views

Authorizations

Body

Response