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 Get Profile API?

The DI REST API submits the data for processing, specifying various parameters and the event type.

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://crux.dev.hxcb.now.hclsoftware.cloud/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".
CUSTOMER_ID String User ID or anonymous ID for this event.
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://crux.dev.hxcb.now.hclsoftware.cloud/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": "14e02ca1-8agg-48e6-a720-20cf4c1bf66f"
}