Skip to main content
node
const fetch = require('node-fetch');

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

let options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
  body: '{"filter":{"contextualLabels":[{"key":"string","value":{"contextualLabelValues":["string"]}}],"displayLabels":[{"key":"string","value":{"displayLabelValues":["string"]}}],"isMuted":true,"labels":{"metaLabels":[{"key":"key","value":"value"}],"operator":"FILTER_OPERATOR_OR_OR_UNSPECIFIED"},"name":"string","severity":["INCIDENT_SEVERITY_UNSPECIFIED"],"status":["INCIDENT_STATUS_UNSPECIFIED"],"timestamp":{"endTime":"2019-08-24T14:15:22Z","startTime":"2019-08-24T14:15:22Z"}},"orderBy":{"direction":"ORDER_BY_DIRECTION_UNSPECIFIED","field":"INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED"},"pagination":{"pageSize":10,"pageToken":"next_page_token"}}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "items": [
    {
      "cxEventKey": "<string>",
      "cxEventTimestamp": "2023-11-07T05:31:56Z",
      "incidentEvent": {
        "administrativeEvent": {
          "userId": "<string>"
        },
        "id": "incident_event_id",
        "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
        "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
        "snoozeIndicator": {
          "durationMinutes": 123,
          "startTime": "2023-11-07T05:31:56Z",
          "userId": "<string>"
        }
      },
      "incidentEventExtendedMetadata": {
        "alertGroupByFields": [
          "<string>"
        ],
        "alertId": "<string>",
        "alertLabels": [
          {
            "key": "key",
            "value": "value"
          }
        ],
        "alertName": "<string>",
        "alertType": "INCIDENT_EVENT_ALERT_TYPE_STANDARD_OR_UNSPECIFIED",
        "incidentPermutation": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "incidentSeverity": "INCIDENT_SEVERITY_UNSPECIFIED",
        "incidentState": "INCIDENT_STATE_UNSPECIFIED",
        "incidentStatus": "INCIDENT_STATUS_UNSPECIFIED",
        "isMuted": true
      }
    }
  ],
  "pagination": {
    "nextPageToken": "next_page_token",
    "totalSize": 100
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

Request to list incident events with filtering, pagination and ordering options

​
filter
object

Filter configuration for incident events

​
orderBy
object
​
pagination
object

Pagination parameters for list requests

Response

A response containing a list of incident events and pagination information

​
items
Extended incident event · object[]
required
​
pagination
object

Pagination information for list responses

⌘I