Data Ingestion REST API

This page talks about how to use HCL CDP Data Ingestion (DI) REST API to submit data for processing, specifying various parameters and event types.

What is the DI REST API?

The DI REST API ingests the event data into CDP for SST enhancement and profile creation. Real-time and batch segments use the CT events ingested via DI REST API for data segmentation. The live events are visible only for SST events, which are ingested via DI API. Further, these SST events will be displayed in the Funnel, Path and Activity tab.

Authentication

In any of the API requests, pass the mandatory parameters as below in the authentication request header.

Request headers:


Parameter	Type	Description
x-api-key	String	API key for authentication. Shared by HCL CDP
x-api-passkey	String	Passkey for additional authentication

Endpoints

Post https://<base_url>/v3/data

Submit data for processing, specifying various parameters and the event type.

Query String parameters:


Parameter	Type	Description
properties	Object	Additional properties of the event in the form of param:value. For example, "param1": "data1".
Primary Identifier (Custom Field)	String	Customizable primary identifier for each tenant. Its value may vary depending on the tenant's system—for example, it can represent a Customer ID, CRM ID, Identity Number, or any other unique identifier defined by the tenant.
eventname	String	Name of the event.
type	String	Accepts any one of the value: "identify" or "track".

Response Content-Type: application/json

Response body parameters:


Parameter	Type	Description
message	String	The status of the request. "Success" in case of 200 OK response.
id	String	Unique identifier for the processed data entry.

Example Request:

POST https://<base_url>/v3/data
Headers:
  x-api-key: your_api_key
  x-api-passkey: your_passkey
  Content-Type: application/json

Body:
{
  "properties": {
    "param1": "value1",
    "param2": "value2",
    "param3": "value3",
    "paramX": "valueX",
    "CUSTOMER_ID": "000123111"
  },
  "eventname": "user_signup",
  "type": "track"
}

Response:

{
  "message": "Data Processed successfully",
  "id": "14e02sa1-8agg-48e6-a720-20cf4c1bf66f"
}