Get Profile API

This page talks about how to use HCL CDP User Profile API to pull data from HCL CDP.

What is the Get Profile API?

The Get Profile API retrieves user profile information and associated segments based on a specified campaign and tenant ID.

Authentication

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

Request headers:


Parameter	Type	Description
auth_key	String	API key for authentication. Shared by HCL CDP

Endpoints

GET /getProfileAndSegments?campaign=%3CTenantID%3E&key=%3CKey%3E&lock_type=none&auth_key=%3CAuthKey%3E&lookup=multi

Sample Endpoint URL:

GET https://dmp-sst-api.dev.hxcb.now.hclsoftware.cloud/api/v1/getProfileAndSegments?campaign=<TenantID>&key=<KEY>&lock_type=none&auth_key=<AuthKey>&lookup=multi

Get the profile of the user which includes online behavioral data and third-party taxonomy data.

Query String parameters:


Parameter	Type	Description
key	String	The identifier for the user. It can be either of HCL CDP Cookie or hashed crmid or hashed email-id or hashed phone number.
campaign	String	The ID of the campaign (Tenant ID).
lock_type	String	The type of lock (default is "none").
auth_key	String	The authentication key Shared by HCL CDP.
lookup	String	Type of lookup, e.g., "multi"

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.
data	JSON	The profile data in JSON format. The attributes of data mentioned below

The JSON attributes of the data:


Parameter	Type	Description
data	Object	Contains the profile data.
data.pf	Object	Profile details of the user.
data.pf.key_type	string	Type of key used (e.g., "crmid").
data.pf.city	string	The city of the user (e.g., "Nashik, India").
data.pf.ls	string	Last updated timestamp in the format "YYYY-MM-DD-HH:MM
data.pf.ls	string	".
data.pf.dtyp	string	Device type used by the user (e.g., "DESKTOP").
data.pf.mid	string	Unique identifier for the session (e.g., "b3b52319-c297-4e6a-9253-cd7eca8637b2").
data.pf.cont_uaov	string	User's operating system and version (e.g., "Windows 11").
data.pf.typ	string	Type of interaction (e.g., "track").
data.pf.oid	Array	List of objects containing identifiers.
data.pf.oid[].id	string	Unique identifier (e.g., "viz_66683a576100335").
data.pf.oid[].type	string	Type of identifier (e.g., "vizid").
data.pf.oid[].ts	number	Timestamp associated with the identifier.
data.pf.sourcets	string	Source timestamp when the profile was created or fetched.
data.pf.fs	string	First seen timestamp in the format "YYYY-MM-DD-HH:MM
data.pf.fs	string	".
data.pf.crmid	string	Unique customer relationship management ID (e.g., "85748559955").
data.pf.cont_libnm	string	Name of the library used for the connection (e.g., "javascript").
data.pf.actts	number	Timestamp for the last activity.
data.pf.cont_libv	string	Version of the library used (e.g., "0.02").
data.pf.evnt	Array	List of events associated with the user (e.g., ["ccSubmit"]).
data.pf.wosvs	Object	Object containing information about the Windows operating system version.
data.pf.wosvs.Windows 11	Object	Contains the timestamp for Windows 11.
data.pf.key	string	The key of the user profile (e.g., "85748559955").
data.pf.cont_ip	string	User's IP address (e.g., "103.182.196.1").
data.pf.apid	string	Unique identifier for the API session (e.g., "b3b52319-c297-4e6a-9253-cd7eca8637b2").
data.pf.cont_servts	number	Timestamp for the server connection.
data.pf.cont_uabrv	string	User agent browser version (e.g., "Chrome").
data.pf.lastname	string	User's last name (e.g., "Sunil R").
data.pf.zipcode	string	User's ZIP code (e.g., "422009").
data.pf.vizid	string	Visualization identifier (e.g., "viz_66683a576100335").
data.pf.wotyp	Object	Contains details about the Windows type and its timestamp.
data.pf.wotyp.Windows	Object	Contains the timestamp for the Windows OS type.
data.pf.cont_uaot	string	Operating system name (e.g., "Windows").
data.pf.lsts	string	Last seen timestamp in the format "YYYY-MM-DD-HH:MM
data.pf.lsts	string	".
data.pf.name	string	User's first name (e.g., "Yes1").
data.pf.tpv	string	Third-party version (e.g., "5.0").
data.pf.cont_srcid	string	Source ID for the connection (e.g., "1123").
data.pf.nm	Array	Additional user names or identifiers, if any (usually empty).
id	string	Unique request identifier (e.g., "20osya3LIJ2hvXWROKzy").
key	string	The same key as in the user profile (e.g., "85748559955").

Example Request:

GET dmp-sst-api.dev.hxcb.now.hclsoftware.cloud/api/v1/getProfileAndSegments?campaign=ABCVFM6325&key=959465553364&lock_type=none&auth_key=L8sgGeRcnfjf1BDTFNyT6Ej8AmE&lookup=multi

Response:

{
  "data": {  
    "seg": {
            "segList": [
                {
                    "94598": "testSegment"
                },
                {
                    "94597": "citySegment"
                }
            ]
        },
    "pf": {
      "key_type": "crmid",
      "city": "Nashik,India",
      "ls": "2024-09-17-08:45:19",
      "dtyp": "DESKTOP",
      "mid": "b3b52319-c297-4e6a-9253-cd7eca8637b2",
      "cont_uaov": "Windows 11",
      "typ": "track",
      "oid": [
        {
          "id": "viz_66683a576100335",
          "type": "vizid",
          "ts": 1726562719544
        }
      ],
      "sourcets": "2024-09-17-08:45:19",
      "fs": "2024-09-17-08:33:06",
      "crmid": "85748559955",
      "cont_libnm": "javascript",
      "actts": 1726562719518,
      "cont_libv": "0.02",
      "evnt": [
        "ccSubmit"
      ],
      "wosvs": {
        "Windows 11": {
          "ts": "2024-09-17-08:45:19.541"
        }
      },
      "key": "85748559955",
      "cont_ip": "103.182.196.1",
      "apid": "b3b52319-c297-4e6a-9253-cd7eca8637b2",
      "cont_servts": 1726562719518,
      "cont_uabrv": "Chrome",
      "lastname": "Sunil R",
      "zipcode": "422009",
      "vizid": "viz_66683a576100335",
      "wotyp": {
        "Windows": {
          "ts": "2024-09-17-08:45:19.542"
        }
      },
      "cont_uaot": "Windows",
      "lsts": "2024-09-17-08:45:19",
      "name": "Yes1",
      "tpv": "5.0",
      "cont_srcid": "1123",
      "nm": []
    }
  },
  "id": "20osya3LIJ2hvXWROKzy",
  "key": "85748559955"
}

Note: The key should be URL-encoded.