Events Service

Get Event

Returns the alert event with the specified ID.

get/alerts/events/v3/{id}

Request

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

Path parameters

idstring required

Unique identifier of the alert event to retrieve.

Example:test

Query parameters

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.

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"
}

Response

Example response

{
  "event": {
    "multipleEvents": {
      "events": [
        {
          "companyId": 1,
          "cxEventDedupKey": "test_dedup_key",
          "cxEventKey": "test",
          "cxEventPayloadType": "test_payload_type",
          "cxEventTimestamp": "2024-05-05T00:00:00.000Z",
          "cxEventType": "test_type"
        }
      ]
    },
    "singleEvent": {
      "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.