Custom Entity Records (Bulk)

Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

This bulk API allows you to search and retrieve data related to interactions such as customer calls alongside the associated profile data, such as name, contact information, and more.

Note:
If multiple interactions match the same profile, the response includes only one instance of the profile data.

Endpoint URL

The API endpoint where you send data is:

/cxs/customObject/search/

HTTP Method

The method to be used for the request:

POST

Request Body Structure

To search for interaction data, structure your request body as follows:

{
    "limit": 1,
    "objectType": "interaction",
    "condition": {
        "type": "profilePropertyCondition",
        "parameterValues": {
            "propertyName": "properties.Source.Keyword",
            "comparisonOperator": "equals",
            "propertyValue": "ACM"
        }
    }
}

Example: The following request depicts retrieving the Collection campaign interaction within a specific time range.

   {
        "limit": 100,
        "objectType":"interaction",
        "condition": {
            "type": "booleanCondition",
            "parameterValues": {
                "operator": "and",
                "subConditions": [
                    {
                        "type": "profilePropertyCondition",
                        "parameterValues": {
                            "propertyName": "properties.CampaignID.keyword",
                            "comparisonOperator": "equals",
                            "propertyValue": "Collection"
                        }
                    },
                    {
                        "type": "profilePropertyCondition",
                        "parameterValues": {
                            "propertyName": "systemProperties.CreatedTimestamp",
                            "comparisonOperator": "greaterThan",
                            "propertyValue": "2024-10-16T07:44:10Z"
                        }
                    },
                    {
                        "type": "profilePropertyCondition",
                        "parameterValues": {
                            "propertyName": "systemProperties.CreatedTimestamp",
                            "comparisonOperator": "lessThan",
                            "propertyValue": "2024-10-17T07:44:10Z"
                        }
                    }
                ]
            }
        }
    }

Note:
You can apply additional filters based on the available interaction data attributes to customize your API requests.

Request Field Descriptions

This table outlines the required fields for the API request, including their types, whether they are mandatory, and their descriptions.

Field Name	Data Type	Required	Description
limit	Integer	Yes	Specifies the maximum number of records to retrieve per API request. If the query matches up to 5000 records, all matching records are pulled. If the query exceeds 5000 records, only the first 5000 records are retrieved. If there are more than 5000 records, use pagination logic to fetch the next set of records. Note: The time range specified in the query does not affect the limit.
objectType	String	Yes	The type of object to fetch; in this case, it must be interaction.
type	String	Yes	Should always be profilePropertyCondition
parameterValues	String	Yes	Specifies the condition for a profile property, such as a comparison or logical operation, depending on the context in which it is used.
operator	String	Yes	Logical operator: either "and" or "or."
parameterValues	String	Yes	Defines a condition used to construct the query and retrieve the corresponding records. This condition is formed by combining three elements: propertyName: Specifies the property being queried. For example, systemProperties.CreatedTimestamp refers to the creation timestamp stored in the system metadata. comparisonOperator: Indicates the condition to filter data. Operators like lessThan, greaterThan, or equals are used to define the filtering criteria. propertyValue: Provides the timestamp for comparison in ISO 8601 format. In this case, it represents the timestamp to which the CreatedTimestamp is compared.

Sample Response

{
    "list": [
        {
            "profile": {
                "itemId": "9354e371-e5ce-4bee-bed7-20755967ad2b",
                "itemType": "profile",
                "scope": "1-1",
                "version": 450,
                "objectType": null,
                "properties": {
                    "Age": 54,
                    "ContactID": "003GA000044SR2RYAW",
                    "Email": "joesmith@acqueon.com",
                    "Emails": [
                        "joesmith@acqueon.com"
                    ],
                    "FirstName": "Joe",
                    "Home": "18287716924",
                    "LastName": "Smith",
                    "Mobile": "18287716924",
                    "Office": "18287716924",
                    "PhoneNumbers": [
                        "18287716924"
                    ],
                    "Primary": "0017F00000nqkLTQAY"
                },
                "systemProperties": {
                    "ProfileCreatedTimestamp": 1727174890000,
                    "ProfileUpdatedTimestamp": 1733734813000
                },
                "segments": [],
                "scores": null
            },
            "customObjects": [
                {
                    "itemId": "2f260701-a063-451a-8961-ee449955c22d",
                    "itemType": "customobject",
                    "scope": "1-1",
                    "version": 1,
                    "objectType": "interaction",
                    "profileId": "9354e371-e5ce-4bee-bed7-20755967ad2b",
                    "systemProperties": {
                        "UpdatedTimestamp": "2024-09-26T06:53:54Z",
                        "CreatedTimestamp": "2024-09-26T06:53:54Z"
                    },
                    "properties": {
                        "ReservationCallDuration": 0,
                        "IsNonAttempt": false,
                        "AgentComments": "",
                        "OverridePEWCValidation": false,
                        "ChildListID": 317826,
                        "ModeId": 2,
                        "ActualContactNumber": "18287716924",
                        "CampaignGroupName": "AcqDlr_BasicQueue",
                        "DNCBussField": "",
                        "CallBackAttemptType": "",
                        "ContactNumber": "18287716924",
                        "TargetAmount": 0,
                        "SFCampaignId": "0",
                        "SkillgroupID": -1,
                        "Status": 0,
                        "GID": 0,
                        "ContactTries": 2,
                        "CallOutcome": 20,
                        "IdentityAuthenticationEnabled": false,
                        "ScheduledDeliveryTime": "2024-09-26T06:51:31",
                        "SFLeadId": "0",
                        "OutcomeDescription": "Agent Skip Close",
                        "Duration": 0,
                        "DialingMode": "1",
                        "IsCurrentCycleCompleted": false,
                        "StateLawGroupName": "",
                        "VerifiedPrimaryAuth": 0,
                        "CampaignCategoryID": 0,
                        "Campaignkey": 195,
                        "CallBackRequestedBy": "LCM",
                        "DeliveredTime": "2024-09-26T06:53:07",
                        "BlockedBy": "",
                        "ConditionID": 4028,
                        "StatusReasonId": 49,
                        "AgentID": "AcqDlr_ATIDemoOps",
                        "CurrentLeadScore": 0,
                        "PreviewDuration": 20,
                        "StatusChangedBy": "0",
                        "CallID": "c28bd6ce-1d36-40c6-b008-4a3a675e08d4",
                        "TotalPrimaryAuth": 0,
                        "CallType": 0,
                        "Uploadedtime": "2024-09-26T06:41:13",
                        "ICMId": 0,
                        "DNCType": 0,
                        "ContactId": 3784,
                        "LCMKey": "3784|2|195|1|0|44|1",
                        "DiallerReferenceID": "",
                        "SFUID": 0,
                        "CallStartDateTime": "2024-09-26T06:53:42",
                        "ComputedDurationInMS": 0,
                        "UserID": "LCM",
                        "DeliveredType": "Dialer-Regular",
                        "VerifiedSecondaryAuth": 0,
                        "PreviousLeadScore": 0,
                        "DialerId": 9,
                        "CurrentCycle": 1,
                        "DialerAgentCallback": false,
                        "IdentityAuthenticationSuccess": false,
                        "DialerDateTime": "2024-09-26T06:53:42",
                        "PlatformContactID": "",
                        "SFContactId": "0",
                        "IsWireless": true,
                        "PreviewTime": "2024-09-26T06:53:53",
                        "DeviceID": "",
                        "NextScheduleMode": "1",
                        "CallReferenceID": "",
                        "SMSTransactionCount": 0,
                        "NextScheduleDateTime": "2024-09-26T07:08:53",
                        "DialPlanName": "Default_Advanced_Strategy",
                        "DNCCampaignCategoryID": "",
                        "ICRCallKey": "0",
                        "StatusChangedAt": "2024-09-26T06:53:53",
                        "IsInbound": false,
                        "TotalSecondaryAuth": 0,
                        "TargetCampaignGroup": "",
                        "ContactDetail": "<Data><FirstName><![CDATA[John]]></FirstName><LastName><![CDATA[Wick]]></LastName><Loan_No><![CDATA[A34524347824]]></Loan_No><D_Amt><![CDATA[3872]]></D_Amt><D_Dt><![CDATA[10/24/2019]]></D_Dt><LT><![CDATA[Personal]]></LT><Hub><![CDATA[North]]></Hub><Seg><![CDATA[Single]]></Seg><S_Seg><![CDATA[HE]]></S_Seg><Cust_Add><![CDATA[Suite 3 Rosewood Colony]]></Cust_Add><Place><![CDATA[New Jersy]]></Place><PostalCode><![CDATA[80984]]></PostalCode><Fn><![CDATA[C345213]]></Fn><FW_DB><![CDATA[323145623]]></FW_DB><BusinessC><![CDATA[C345213]]></BusinessC><Scode><![CDATA[323145645]]></Scode><AID><![CDATA[G32]]></AID><T_Field1><![CDATA[G345631]]></T_Field1><R_Mgr><![CDATA[C34521345]]></R_Mgr><R_CallDts><![CDATA[3477096456]]></R_CallDts><LonaAmt><![CDATA[387200]]></LonaAmt><Dues_Bal><![CDATA[4]]></Dues_Bal><LC_ID><![CDATA[C345213]]></LC_ID><Level><![CDATA[4277XXXXXXXX5485]]></Level><DT_App><![CDATA[10/10/2019]]></DT_App><Off_App><![CDATA[G345631]]></Off_App><Home><![CDATA[18287716924]]></Home><Mobile><![CDATA[18287716924]]></Mobile><Office><![CDATA[18287716924]]></Office><EmailID><![CDATA[john.wick@acqueon.com]]></EmailID><AgentID><![CDATA[18051]]></AgentID><ContPrior><![CDATA[1]]></ContPrior><CallDate><![CDATA[22/11/2018]]></CallDate></Data>",
                        "CallbackRegisteredType": 0,
                        "ListID": 1516,
                        "CampaignID": "Collection",
                        "RouterCallKeySequenceNumber": 0,
                        "ChannelType": 2
                    }
                },
                {
                    "itemId": "2fa53a95-5680-4f9e-97ee-df0f52e53369",
                    "itemType": "customobject",
                    "scope": "1-1",
                    "version": 1,
                    "objectType": "interaction",
                    "profileId": "9354e371-e5ce-4bee-bed7-20755967ad2b",
                    "systemProperties": {
                        "UpdatedTimestamp": "2024-09-26T12:54:19Z",
                        "CreatedTimestamp": "2024-09-26T12:54:19Z"
                    },
                    "properties": {
                        "ReservationCallDuration": 0,
                        "IsNonAttempt": false,
                        "AgentComments": "",
                        "OverridePEWCValidation": false,
                        "ChildListID": 317826,
                        "ModeId": 1,
                        "ActualContactNumber": "18287716924",
                        "CampaignGroupName": "AcqDlr_BasicQueue",
                        "DNCBussField": "",
                        "CallBackAttemptType": "",
                        "ContactNumber": "18287716924",
                        "TargetAmount": 0,
                        "SFCampaignId": "0",
                        "SkillgroupID": -1,
                        "Status": 1,
                        "GID": 0,
                        "ContactTries": 3,
                        "CallOutcome": 20,
                        "IdentityAuthenticationEnabled": false,
                        "ScheduledDeliveryTime": "2024-09-26T07:08:53",
                        "SFLeadId": "0",
                        "OutcomeDescription": "Agent Skip Close",
                        "Duration": 0,
                        "DialingMode": "1",
                        "IsCurrentCycleCompleted": false,
                        "StateLawGroupName": "",
                        "VerifiedPrimaryAuth": 0,
                        "CampaignCategoryID": 0,
                        "Campaignkey": 195,
                        "CallBackRequestedBy": "LCM",
                        "DeliveredTime": "2024-09-26T07:10:31",
                        "BlockedBy": "",
                        "ConditionID": 4028,
                        "StatusReasonId": 43,
                        "AgentID": "AcqDlr_Subramanian",
                        "CurrentLeadScore": 0,
                        "PreviewDuration": 59,
                        "StatusChangedBy": "0",
                        "CallID": "5bcab66f-fe5b-4c1b-b242-d9e38e1cdbb3",
                        "TotalPrimaryAuth": 0,
                        "CallType": 0,
                        "Uploadedtime": "2024-09-26T06:41:13",
                        "ICMId": 0,
                        "DNCType": 0,
                        "ContactId": 3784,
                        "LCMKey": "3784|1|195|2|0|44|1",
                        "DiallerReferenceID": "",
                        "SFUID": 0,
                        "CallStartDateTime": "2024-09-26T12:54:08",
                        "ComputedDurationInMS": 0,
                        "UserID": "LCM",
                        "DeliveredType": "Dialer-Regular",
                        "VerifiedSecondaryAuth": 0,
                        "PreviousLeadScore": 0,
                        "DialerId": 9,
                        "CurrentCycle": 1,
                        "DialerAgentCallback": false,
                        "IdentityAuthenticationSuccess": false,
                        "DialerDateTime": "2024-09-26T12:54:08",
                        "PlatformContactID": "",
                        "SFContactId": "0",
                        "IsWireless": true,
                        "PreviewTime": "2024-09-26T12:54:18",
                        "DeviceID": "",
                        "NextScheduleMode": "1",
                        "CallReferenceID": "",
                        "SMSTransactionCount": 0,
                        "DialPlanName": "Default_Advanced_Strategy",
                        "DNCCampaignCategoryID": "",
                        "ICRCallKey": "0",
                        "StatusChangedAt": "2024-09-26T12:54:18",
                        "IsInbound": false,
                        "TotalSecondaryAuth": 0,
                        "TargetCampaignGroup": "",
                        "ContactDetail": "<Data><FirstName><![CDATA[John]]></FirstName><LastName><![CDATA[Wick]]></LastName><Loan_No><![CDATA[A34524347824]]></Loan_No><D_Amt><![CDATA[3872]]></D_Amt><D_Dt><![CDATA[10/24/2019]]></D_Dt><LT><![CDATA[Personal]]></LT><Hub><![CDATA[North]]></Hub><Seg><![CDATA[Single]]></Seg><S_Seg><![CDATA[HE]]></S_Seg><Cust_Add><![CDATA[Suite 3 Rosewood Colony]]></Cust_Add><Place><![CDATA[New Jersy]]></Place><PostalCode><![CDATA[80984]]></PostalCode><Fn><![CDATA[C345213]]></Fn><FW_DB><![CDATA[323145623]]></FW_DB><BusinessC><![CDATA[C345213]]></BusinessC><Scode><![CDATA[323145645]]></Scode><AID><![CDATA[G32]]></AID><T_Field1><![CDATA[G345631]]></T_Field1><R_Mgr><![CDATA[C34521345]]></R_Mgr><R_CallDts><![CDATA[3477096456]]></R_CallDts><LonaAmt><![CDATA[387200]]></LonaAmt><Dues_Bal><![CDATA[4]]></Dues_Bal><LC_ID><![CDATA[C345213]]></LC_ID><Level><![CDATA[4277XXXXXXXX5485]]></Level><DT_App><![CDATA[10/10/2019]]></DT_App><Off_App><![CDATA[G345631]]></Off_App><Home><![CDATA[18287716924]]></Home><Mobile><![CDATA[18287716924]]></Mobile><Office><![CDATA[18287716924]]></Office><EmailID><![CDATA[john.wick@acqueon.com]]></EmailID><AgentID><![CDATA[18051]]></AgentID><ContPrior><![CDATA[1]]></ContPrior><CallDate><![CDATA[22/11/2018]]></CallDate></Data>",
                        "CallbackRegisteredType": 0,
                        "ListID": 1516,
                        "CampaignID": "Collection",
                        "RouterCallKeySequenceNumber": 0,
                        "ChannelType": 2
                    }
                },
                {
                    "itemId": "91e8e9d1-e1e2-407e-a175-3494306bce9b",
                    "itemType": "customobject",
                    "scope": "1-1",
                    "version": 1,
                    "objectType": "interaction",
                    "profileId": "9354e371-e5ce-4bee-bed7-20755967ad2b",
                    "systemProperties": {
                        "UpdatedTimestamp": "2024-09-25T10:58:52Z",
                        "CreatedTimestamp": "2024-09-25T10:58:52Z"
                    },
                    "properties": {
                        "ReservationCallDuration": 0,
                        "IsNonAttempt": false,
                        "AgentComments": "",
                        "OverridePEWCValidation": false,
                        "ChildListID": 317817,
                        "ModeId": 1,
                        "ActualContactNumber": "18287716924",
                        "CampaignGroupName": "AcqDlr_BasicQueue",
                        "DNCBussField": "",
                        "CallBackAttemptType": "",
                        "ContactNumber": "18287716924",
                        "TargetAmount": 0,
                        "SFCampaignId": "0",
                        "SkillgroupID": -1,
                        "Status": 1,
                        "GID": 0,
                        "ContactTries": 2,
                        "CallOutcome": 107,
                        "IdentityAuthenticationEnabled": false,
                        "ScheduledDeliveryTime": "2024-09-25T10:52:18",
                        "SFLeadId": "0",
                        "OutcomeDescription": "Pre-Closure Initiated",
                        "Duration": 18000,
                        "DialingMode": "1",
                        "IsCurrentCycleCompleted": false,
                        "StateLawGroupName": "",
                        "VerifiedPrimaryAuth": 0,
                        "CampaignCategoryID": 0,
                        "Campaignkey": 195,
                        "CallBackRequestedBy": "LCM",
                        "DeliveredTime": "2024-09-25T10:53:46",
                        "BlockedBy": "",
                        "ConditionID": 4007,
                        "StatusReasonId": 46,
                        "AgentID": "AcqDlr_ATIDemoOps",
                        "CurrentLeadScore": 0,
                        "PreviewDuration": 81,
                        "StatusChangedBy": "0",
                        "CallID": "c8401576-b88b-4985-8eec-932cb4fa8bff",
                        "TotalPrimaryAuth": 0,
                        "CallType": 0,
                        "Uploadedtime": "2024-09-25T10:37:41",
                        "ICMId": 0,
                        "DNCType": 0,
                        "ContactId": 3783,
                        "LCMKey": "3783|1|195|1|0|44|1",
                        "DiallerReferenceID": "05e3da35-a4d0-4ee5-abf2-82b41e97cbee",
                        "SFUID": 0,
                        "CallStartDateTime": "2024-09-25T10:56:25",
                        "ComputedDurationInMS": 30000,
                        "UserID": "LCM",
                        "DeliveredType": "Dialer-Regular",
                        "VerifiedSecondaryAuth": 0,
                        "PreviousLeadScore": 0,
                        "DialerId": 9,
                        "CurrentCycle": 1,
                        "DialerAgentCallback": false,
                        "IdentityAuthenticationSuccess": false,
                        "DialerDateTime": "2024-09-25T10:56:43",
                        "PlatformContactID": "",
                        "SFContactId": "0",
                        "IsWireless": true,
                        "PreviewTime": "2024-09-25T10:58:51",
                        "DeviceID": "",
                        "NextScheduleMode": "1",
                        "CallReferenceID": "",
                        "SMSTransactionCount": 0,
                        "DialPlanName": "Default_Advanced_Strategy",
                        "DNCCampaignCategoryID": "",
                        "ICRCallKey": "0",
                        "StatusChangedAt": "2024-09-25T10:58:51",
                        "IsInbound": false,
                        "TotalSecondaryAuth": 0,
                        "TargetCampaignGroup": "",
                        "ContactDetail": "<Data><FirstName><![CDATA[Arthur]]></FirstName><LastName><![CDATA[Leywin]]></LastName><Loan_No><![CDATA[A34524347824]]></Loan_No><D_Amt><![CDATA[3872]]></D_Amt><D_Dt><![CDATA[10/24/2019]]></D_Dt><LT><![CDATA[Personal]]></LT><Hub><![CDATA[North]]></Hub><Seg><![CDATA[Single]]></Seg><S_Seg><![CDATA[HE]]></S_Seg><Cust_Add><![CDATA[Suite 3 Rosewood Colony]]></Cust_Add><Place><![CDATA[New Jersey]]></Place><PostalCode><![CDATA[80984]]></PostalCode><Fn><![CDATA[C345213]]></Fn><FW_DB><![CDATA[323145623]]></FW_DB><BusinessC><![CDATA[C345213]]></BusinessC><Scode><![CDATA[323145645]]></Scode><AID><![CDATA[G32]]></AID><T_Field1><![CDATA[G345631]]></T_Field1><R_Mgr><![CDATA[C34521345]]></R_Mgr><R_CallDts><![CDATA[3477096456]]></R_CallDts><LonaAmt><![CDATA[387200]]></LonaAmt><Dues_Bal><![CDATA[4]]></Dues_Bal><LC_ID><![CDATA[C345213]]></LC_ID><Level><![CDATA[4277XXXXXXXX5485]]></Level><DT_App><![CDATA[10/10/2019]]></DT_App><Off_App><![CDATA[G345631]]></Off_App><Home><![CDATA[18287716924]]></Home><Mobile><![CDATA[18287716924]]></Mobile><Office><![CDATA[18287716924]]></Office><EmailID><![CDATA[dileep.kumar@acqueon.com]]></EmailID><AgentID><![CDATA[18051]]></AgentID><ContPrior><![CDATA[1]]></ContPrior><CallDate><![CDATA[22/11/2018]]></CallDate></Data>",
                        "CallbackRegisteredType": 0,
                        "ListID": 1515,
                        "CampaignID": "Collection",
                        "RouterCallKeySequenceNumber": 0,
                        "ChannelType": 2
                    }
                }
            ]
        }
    ],
    "offset": 0,
    "pageSize": 1,
    "totalSize": 1,
    "totalSizeRelation": "EQUAL",
    "sort": null
}

To know how pagination is handled for these API responses, refer here.

Note:
All datetime values in the above response are displayed based on the time zone configured on the Global Settings page. Any changes to this setting take effect in the response after 10 minutes.

Response Field Description

This table outlines the response fields for the API request, including their types, whether they are, and their descriptions.

Field Name	Data Type	Description
Profile Details
ItemId	String	Specifies the interaction ID.
itemType	String	Specifies the type of item. This value will always be custom entity.
scope	String	Refers to the combination of the tenant and subtenant, indicating the specific context or environment in which the data is applicable.
version	String	Represents the version of the document or record, indicating its revision or update state.
objectType	String	The type of object to fetch; in this case, it must be interaction.
properties	String	Contains profile-specific information such as age, phone numbers, and more.
systemProperties	Object	Specifies these system properties: CreatedTimestamp -The date and time when the record or interaction was first created in the system UpdatedTimestamp - The date and time when the record or interaction was last modified or updated in the system.
segments	String	Contains the names of the segments to which the profile belongs, helping to categorize the profile based on predefined criteria.
score	Integer	Currently not used.
Custom Objects
itemId	String	Unique identifier for the custom object
itemType	String	Type of the item which is custom object here.
scope	String	Refers to the combination of the tenant and subtenant, indicating the specific context or environment in which the data is applicable.
version	Integer	Represents the version of the document or record, indicating its revision or update state.
objectType	String	Specifies the type of custom object, which is Interaction here.
profileId	String	ID of the profile linked to the custom object.
properties	String	Contains interaction-specific details, including call information (for example, duration, outcome), campaign and scheduling data, agent activity, and validation/authentication statuses). It captures all key metadata related to the interaction.
Offset	Integer	Specifies the number of records skipped in the query result. It is the same value as sent in the query and defaults to 0 if not specified.
pageSize	Integer	Defines the number of records returned in the current response.
totalSize	Integer	Represents the total number of records that match the query criteria.
totalSizeRelation	String	Represents the relationship of the total size in the query. The value can be either "EQUAL" or "GREATER_THAN_OR_EQUAL TO", indicating whether the total size is exactly equal to or greater than the total number of matching records.

Limit

The following table outlines the limit and how child entities are handled for the Data Ingestion API.

Parameter	Limit	Notes
Maximum response size	10 MB or 5000 records	Responses include up to 5000 profiles or a total size of 10MB, whichever is reached first. If the 10MB limit is reached, the number of profiles is reduced to stay within this size.

Error Response

The following table outlines the error responses for the API with descriptions.

Error Response	Description
401 – Unauthorized	Indicates that the authentication token provided is either invalid or has expired.
405 – Method not allowed	Indicates that the HTTP method used in the request is not allowed for the specified resource.
400 -Bad Request	The input format is incorrect. Refer to the documentation for the correct format.

Was this article helpful?

What's Next

Fetch Profiles (Bulk)

Table of contents

Overview
Endpoint URL
HTTP Method
Request Body Structure
Request Field Descriptions
Sample Response
Response Field Description
Limit
Error Response