Collect Events

post http://{{url}}/v1/{clientId}/events

Collect Events

Behaviour

This API is designed to collect events for tracking purposes. The collected events are stored in the tracking data warehouse, enabling comprehensive reporting across Cortex features, including Promo Assets and Campaigns Management.

A maximum of 100 events can be sent in a single request. Different event types can be included in the same request.

Example Article Request Event

{
    "events": [{
        "eventId": "D37882D6-56DF-58A8-A3AB-26BD84250631",
        "eventType": "REQUEST",
        "createdTimestamp": "2020-08-12T13:00:52.531Z",
        "sentTimestamp": "2020-08-12T13:00:52.531Z",
        "deviceId": "123",
        "appVersion": "1.2.4",
        "sourceSystem": "ARTICLE",
        "sourceSystemId": "123-456-900-001",
        "campaignCodes": [
            "de8e6695-5f8d-44ea-9a62-070aa12a0034",
            "4ee8a0f1-ddc5-424f-8139-7db01e6eb045"
        ],
        "metadata": {
            "language": "en",
            "version": 11
        }
    }]
}

Example Push Deep Link Click Event

{
    "events": [{
        "eventId": "d68cc997-d8f3-4692-a2f5-d2255e1a3c43",
        "eventType": "DEEP_LINK_CLICK",
        "createdTimestamp": "2020-08-12T13:00:52.531Z",
        "sentTimestamp": "2020-08-12T13:00:52.531Z",
        "deviceId": "123",
        "appVersion": "1.2.4",
        "sourceSystem": "PUSH",
        "externalId": "123-456-900-001",
        "metadata": {
            "link": "some_link"
        }
    }]
}

Example Form Open Event

{
    "events": [{
        "eventId": "D37882D6-56DF-58A8-A3AB-26BD84250632",
        "eventType": "OPEN",
        "createdTimestamp": "2020-08-12T13:00:52.531Z",
        "sentTimestamp": "2020-08-12T13:00:52.531Z",
        "deviceId": "123",
        "appVersion": "1.2.4",
        "sourceSystem": "FORMS",
        "sourceSystemId": "123-456-900-001",
        "campaignCodes": [
            "de8e6695-5f8d-44ea-9a62-070aa12a0034",
            "4ee8a0f1-ddc5-424f-8139-7db01e6eb045"
        ],
        "metadata": {
            "language": "en",
            "version": 11
        }
    }]
}

Example External Event

    {
        "eventId": "D37882D6-56DF-58A8-A3AB-26BD84250632",
        "eventType": "OPEN",
        "createdTimestamp": "2020-08-12T13:00:52.531Z",
        "sentTimestamp": "2020-08-12T13:00:52.531Z",
        "deviceId": "123",
        "appVersion": "1.2.4",
        "authId": 123,
        "sourceSystem": "PUSH",
        "externalId": "123-456-900-001"
    }

Authentication

Authentication is required for this API using an API Key. This API key will be provided by the Cortex support team.

Header	What’s it for	Example Value
X-APP-ID	Defines the application the call is accessing from, e.g. android, ios, or web.	android
X-REALM	Defines the space or client the caller is trying to access, e.g. CORTEX.	cortex
X-API-KEY	Defines the key or password the caller is authenticating with. These will be stored per app ID and realm.	super-secure-key-123