GET
/
v3
/
events
const fetch = require('node-fetch');

let url = 'https://api.coralogix.com/mgmt/openapi/v3/events?filter.timestamp.from=SOME_STRING_VALUE&filter.timestamp.to=SOME_STRING_VALUE&filter.cxEventTypes=SOME_ARRAY_VALUE&filter.cxEventKeys=SOME_ARRAY_VALUE&filter.cxEventMetadataFilters.operator=SOME_STRING_VALUE&pagination.pageSize=SOME_INTEGER_VALUE&pagination.pageToken=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
{
  "events": [
    {
      "cxEventKey": "test",
      "cxEventType": "test_type",
      "cxEventLabels": {
        "test": "test"
      },
      "companyId": 1,
      "cxEventTimestamp": 1714857600,
      "cxEventPayloadType": "test_payload_type",
      "cxEventPayload": {
        "test": "test"
      },
      "cxEventDedupKey": "test_dedup_key",
      "cxEventMetadata": {
        "test": "test"
      }
    }
  ],
  "pagination": {
    "totalSize": 10,
    "nextPageToken": "test"
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

filter.timestamp.from
string
required
filter.timestamp.to
string
required
filter.cxEventTypes
string[]
required
filter.cxEventKeys
string[]
required
filter.cxEventMetadataFilters.operator
enum<string>
default:FILTER_OPERATOR_AND_OR_UNSPECIFIED
Available options:
FILTER_OPERATOR_AND_OR_UNSPECIFIED,
FILTER_OPERATOR_OR
pagination.pageSize
integer
pagination.pageToken
string

Response

200
application/json

A successful response.

This data structure represents a response to list events