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":{"status":["INCIDENT_STATUS_UNSPECIFIED"],"severity":["INCIDENT_SEVERITY_UNSPECIFIED"],"contextualLabels":{"property1":{"contextualLabelValues":["string"]},"property2":{"contextualLabelValues":["string"]}},"name":"string","isMuted":true,"timestamp":{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z"},"labels":{"metaLabels":[{"key":"key","value":"value"}],"operator":"FILTER_OPERATOR_OR_OR_UNSPECIFIED"}},"pagination":{"pageSize":10,"pageToken":"next_page_token"},"orderBy":{"field":"INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED","direction":"ORDER_BY_DIRECTION_UNSPECIFIED"}}'
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
{
"items": [
{
"cxEventKey": "<string>",
"incidentEvent": {
"id": "incident_event_id",
"incidentEventType": "INCIDENT_EVENT_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"
}
},
"originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
"administrativeEvent": {
"userId": "<string>"
},
"operationalEvent": {
"systemName": "<string>"
}
},
"cxEventTimestamp": "2023-11-07T05:31:56Z",
"incidentEventExtendedMetadata": {
"incidentSeverity": "INCIDENT_SEVERITY_UNSPECIFIED",
"alertId": "<string>",
"incidentState": "INCIDENT_STATE_UNSPECIFIED",
"alertName": "<string>",
"alertType": "INCIDENT_EVENT_ALERT_TYPE_STANDARD_OR_UNSPECIFIED",
"isMuted": true,
"incidentStatus": "INCIDENT_STATUS_UNSPECIFIED",
"alertGroupByFields": [
"<string>"
],
"alertLabels": [
{
"key": "key",
"value": "value"
}
],
"incidentPermutation": {}
}
}
],
"pagination": {
"totalSize": 100,
"nextPageToken": "next_page_token"
}
}
List incident events with support for filtering, pagination, and ordering.
Requires the following permissions:
incidents:read
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":{"status":["INCIDENT_STATUS_UNSPECIFIED"],"severity":["INCIDENT_SEVERITY_UNSPECIFIED"],"contextualLabels":{"property1":{"contextualLabelValues":["string"]},"property2":{"contextualLabelValues":["string"]}},"name":"string","isMuted":true,"timestamp":{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z"},"labels":{"metaLabels":[{"key":"key","value":"value"}],"operator":"FILTER_OPERATOR_OR_OR_UNSPECIFIED"}},"pagination":{"pageSize":10,"pageToken":"next_page_token"},"orderBy":{"field":"INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED","direction":"ORDER_BY_DIRECTION_UNSPECIFIED"}}'
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
{
"items": [
{
"cxEventKey": "<string>",
"incidentEvent": {
"id": "incident_event_id",
"incidentEventType": "INCIDENT_EVENT_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"
}
},
"originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
"administrativeEvent": {
"userId": "<string>"
},
"operationalEvent": {
"systemName": "<string>"
}
},
"cxEventTimestamp": "2023-11-07T05:31:56Z",
"incidentEventExtendedMetadata": {
"incidentSeverity": "INCIDENT_SEVERITY_UNSPECIFIED",
"alertId": "<string>",
"incidentState": "INCIDENT_STATE_UNSPECIFIED",
"alertName": "<string>",
"alertType": "INCIDENT_EVENT_ALERT_TYPE_STANDARD_OR_UNSPECIFIED",
"isMuted": true,
"incidentStatus": "INCIDENT_STATUS_UNSPECIFIED",
"alertGroupByFields": [
"<string>"
],
"alertLabels": [
{
"key": "key",
"value": "value"
}
],
"incidentPermutation": {}
}
}
],
"pagination": {
"totalSize": 100,
"nextPageToken": "next_page_token"
}
}
API key authentication
Request to list incident events with filtering, pagination and ordering options
A successful response.
A response containing a list of incident events and pagination information
Was this page helpful?