Events Service

List Events

Returns a list of alert events matching the specified filters.

get/alerts/events/v3

Request

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

Query parameters

cxEventKeysstring[] required

List of event attribute keys to include when retrieving event data.

cxEventTypesstring[] required

List of event type identifiers to include in the results.

Filter criteria for events.

{
  "cxEventKeys": [
    "test_key"
  ],
  "cxEventLabelsFilters": {
    "pathAndValues": [
      {
        "path": "test"
      }
    ]
  },
  "cxEventMetadataFilters": {
    "pathAndValues": [
      {
        "path": "test"
      }
    ]
  },
  "cxEventTypes": [
    "test_type"
  ]
}
pageSizeinteger

Maximum number of results to return per page.

pageTokenstring

Opaque token for fetching the next page of results.

Pagination parameters for the response.

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

Order by direction.

fieldName'ORDER_BY_FIELDS_UNSPECIFIED' | 'ORDER_BY_FIELDS_TIMESTAMP'

Order by fields.

Response

Example response

{
  "events": [
    {
      "companyId": 1,
      "cxEventDedupKey": "test_dedup_key",
      "cxEventKey": "test",
      "cxEventPayloadType": "test_payload_type",
      "cxEventTimestamp": "2024-05-05T00:00:00.000Z",
      "cxEventType": "test_type"
    }
  ],
  "pagination": {
    "nextPageToken": "test",
    "totalSize": 10
  }
}

Changes

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