Login
    Contents x
    Get ADC Customer Journey
      • Dark
        Light
      Contents

      Get ADC Customer Journey

        • Dark
          Light
        Article summary

        Overview

        The GetADCCustomerJourney API allows you to retrieve interaction records from Data Cloud associated with a specific customer profile. It returns the interaction history, including calls and other tracked engagements, linked to the provided Profile ID. The API supports pagination, sorting, and conditional filtering to control the result set.

        Pre-requisite

        The Agent must be on an active call or logged in to the application. Interaction records must exist for the specified Profile ID.

        Sequence Diagram

        Message Structure

        Request Parameters

        Value

        Channel

        LCM

        topic

        Webservice

        subtopic

        GetADCCustomerJourney

        data

        JSON object

        Data Parameters

        Parameter

        Mandatory

        Data Type

        Description

        offset

        Yes

        integer

        Specifies the starting position of records to fetch. Used for pagination.

        limit

        Yes

        integer

        Specifies the maximum number of records returned in a single request.

        objectType

        Yes

        string

        Specifies the type of object to retrieve.

        sortby

        No

        string

        Specifies the field and sort direction (ascending or descending) for the results.

        Example: CallStartDateTime:desc sorts the results by CallStartDateTime in descending order.

        condition

        Yes

        object

        Specifies the field used to apply the filter condition for determining returned records.

        Condition Parameters

        Parameter

        Mandatory

        Data Type

        Description

        type

        Yes

        string

        Specifies the filter type. For filtering based on profile fields, use profilePropertyCondition.

        parameterValues

        Yes

        object

        Contains the attributes and their corresponding values that are used for filtering.

        ParameterValues Parameters

        Parameter

        Mandatory

        Data Type

        Description

        propertyName

        Yes

        string

        Specifies the profile property name used for filtering the results. Example: properties.ProfileId.

        comparisonOperator

        Yes

        string

        Defines the comparison operator used to evaluate the property value. Example: equals.

        propertyValue

        Yes

        string

        Specifies the Profile ID used to retrieve related interaction history records.

        Response Parameters

        Parameter

        Mandatory

        Data Type

        Description

        channel

        Yes

        string

        Indicates the source channel of the response. Returns LCM.

        topic

        Yes

        string

        Indicates the response category. Returns WebService.

        subtopic

        Yes

        string

        Identifies the response type. Returns ADCCustomerJourneyResponse.

        message

        Yes

        object

        Contains the complete response payload returned by the service.

        Message Parameters

        Parameter

        Mandatory

        Data Type

        Description

        response

        Yes

        object

        Contains the list of interaction results and pagination related details.

        Response Object Parameters

        Parameter

        Data Type

        Description

        list

        array

        Contains profile details and associated interaction records.

        offset

        integer

        Indicates the starting index of returned records.

        pageSize

        integer

        Indicates the number of records returned in the current API response.

        totalSize

        integer

        Indicates the total number of matching records available in backend.

        sort

        array

        Indicates the starting offset for the next set of records in a paginated response.

        List Item Parameters

        Parameter

        Data Type

        Description

        profile

        object

        Contains the customer profile details associated with the interactions.

        customObjects

        array

        Contains interaction records linked to the profile.

        Profile Parameters

        Parameter

        Data Type

        Description

        itemId

        string

        Unique identifier of the profile.

        itemType

        string

        Indicates the object type. Returns profile.

        scope

        string

        Defines the scope associated with the profile.

        version

        integer

        Indicates the version of the profile object.

        properties

        object

        Contains customer profile attributes such as name, phone numbers, and email configured for the profile.

        systemProperties

        object

        Contains timestamps indicating when the profile was created and last updated.

        segments

        array

        Provides a list of segments associated with the profile, if any exist.

        CustomObjects Parameters

        Parameter

        Data Type

        Description

        itemId

        string

        Unique identifier of the interaction record.

        itemType

        string

        Indicates the object type. Returns customobject.

        objectType

        string

        Specifies the object category. Returns interaction.

        profileId

        string

        The unique identifier of the profile associated with the interaction.

        properties

        object

        It contains interaction-specific information, including properties such as channel, direction, duration, campaign, outcome, and additional details, which may vary based on the call type.

        systemProperties

        object

        Contains timestamps indicating when the interaction record was created and last updated.

        Properties Parameters (Key Fields)

        Parameter

        Data Type

        Description

        Channel

        string

        Specifies the interaction channel, such as Voice, Email, or SMS.

        Direction

        string

        Specifies the direction of the interaction, either inbound or outbound.

        CallStartDateTime

        string (datetime)

        Specifies the start time of the interaction.

        Duration

        integer

        Specifies the interaction duration.

        Outcome

        string

        Indicates the outcome of the interaction

        CampaignID

        string

        Indicates the campaign associated with the interaction.

        Source

        string

        Identifies the system that generated the interaction record. For Campaign Outbound Call records, the value is ACM, while other records may have Five9, Amazon, Cisco, Genesys, or Salesforce as the source.

        Sample Request

        {
	"subtopic": "GetADCCustomerJourney",
	"topic": "WebService",
	"channel": "LCM",
	"data": {
		"offset": 0,
		"limit": 50,
		"objectType": "interaction",
		"sortby": "CallStartDateTime:desc",
		"condition": {
			"type": "profilePropertyCondition",
			"parameterValues": {
				"propertyName": "properties.ProfileId",
				"comparisonOperator": "equals",
				"propertyValue": "3606f5c3-946d-4ce9-a9de-f5fe0022ea95"
			}
		}
	}

        Sample Response

        {
	"channel": "LCM",
	"topic": "WebService",
	"subtopic": "ADCCustomerJourneyResponse",
	"message": {
		"response": {
			"list": [
				{
					"profile": {
						"itemId": "3606f5c3-946d-4ce9-a9de-f5fe0022ea95",
						"itemType": "profile",
						"scope": "99-99",
						"version": 1,
						"properties": {
							"CallDnis": "+16579994367",
							"Email": "Jane.Doe@ACM.com",
							"FirstName": "Jane",
							"Home": "+",
							"LastName": "Doe",
							"Mobile": "+1657999437",
							"Office": "+16579994374",
							"ProfileId": "3606f5c3-946d-4ce9-a9de-f5fe0022ea95"
						},
						"systemProperties": {
							"ProfileCreatedTimestamp": "2025-12-24 15:14:16.558",
							"ProfileUpdatedTimestamp": "2026-02-11 08:03:12.732",
							"SegmentUpdatedTimestamp": null
						},
						"segments": []
					},
					"customObjects": [
						{
							"itemId": "11afd5e1-4f63-40cd-9e3f-224ef322e81a",
							"itemType": "customobject",
							"scope": "99-99",
							"version": 1,
							"objectType": "interaction",
							"profileId": "3606f5c3-946d-4ce9-a9de-f5fe0022ea95",
							"properties": {
								"ACM_ActualContactNumber": "Jane.Doe@ACM.com",
								"ACM_AgentComments": "",
								"ACM_AgentID": "",
								"ACM_BlockedBy": "",
								"ACM_CallBackAttemptType": "",
								"ACM_CallBackRequestedBy": "LCM",
								"ACM_CallID": "ced2871c-f95b-4f0d-b578-0f1d63b6017d",
								"ACM_CallOutcome": 0,
								"ACM_CallReferenceID": "",
								"ACM_CallStartDateTime": "2026-02-11 07:59:57.000",
								"ACM_CallType": 0,
								"ACM_CallbackRegisteredType": 0,
								"ACM_CampaignGroupName": "ADC_Email_CampaignGroup",
								"ACM_CampaignID": "EmailCampaignForADC",
								"ACM_Campaignkey": 9,
								"ACM_ChannelType": 3,
								"ACM_ChildListID": 431,
								"ACM_ComputedDurationInMS": 0,
								"ACM_ConditionID": 56,
								"ACM_ContactId": 35,
								"ACM_ContactNumber": "Jane.Doe@ACM.com",
								"ACM_ContactTries": 1,
								"ACM_CurrentCycle": 1,
								"ACM_CurrentLeadScore": 0,
								"ACM_DNCBussField": "",
								"ACM_DNCCampaignCategoryID": "",
								"ACM_DNCType": 0,
								"ACM_DeliveredTime": "2026-02-11 07:03:29.000",
								"ACM_DeliveredType": "Dialer-Regular",
								"ACM_DialPlanName": "DigitalCSS_ADC",
								"ACM_DialerDateTime": "2026-02-11 07:59:57.000",
								"ACM_DialerId": 0,
								"ACM_DialingMode": "",
								"ACM_DiallerReferenceID": "17",
								"ACM_Duration": 0,
								"ACM_DurationInSeconds": 0,
								"ACM_ICMId": 0,
								"ACM_ICRCallKey": 0,
								"ACM_LCMKey": "35|4|9|0|0|84|1008",
								"ACM_ListID": 32,
								"ACM_ModeId": 4,
								"ACM_NextScheduleMode": "4",
								"ACM_OutcomeDescription": "Success",
								"ACM_PlatformContactID": "",
								"ACM_PreviewDuration": 0,
								"ACM_PreviousLeadScore": 0,
								"ACM_ReservationCallDuration": 0,
								"ACM_ReservationCallDurationInSeconds": 0,
								"ACM_RouterCallKeySequenceNumber": 0,
								"ACM_SFCampaignId": "0",
								"ACM_SFContactId": "0",
								"ACM_SFLeadId": "0",
								"ACM_SMSTransactionCount": 0,
								"ACM_SkillgroupID": 0,
								"ACM_StateLawGroupName": "",
								"ACM_Status": 1,
								"ACM_StatusChangedAt": "2026-02-11 08:01:38.000",
								"ACM_StatusChangedBy": "0",
								"ACM_StatusReasonId": 46,
								"ACM_TargetAmount": 0,
								"ACM_TargetCampaignGroup": "",
								"ACM_Uploadedtime": "2026-02-11 05:45:51.000",
								"ACM_UserID": "LCM",
								"AcmGid": 0,
								"AcmSfuid": 0,
								"Agent": "",
								"CallId": "ced2871c-f95b-4f0d-b578-0f1d63b6017d",
								"CallStartDateTime": "2026-02-11 07:59:57.000",
								"Channel": "Email",
								"Direction": "Outbound",
								"Duration": 0,
								"Email": "sasikumar.c@acqueon.com",
								"Id": "11afd5e1-4f63-40cd-9e3f-224ef322e81a",
								"Identifier": "35|4|9|0|0|84|1008",
								"Outcome": "Success",
								"ProfileId": "3606f5c3-946d-4ce9-a9de-f5fe0022ea95",
								"Source": "ACM"
							},
							"systemProperties": {
								"CreatedTimestamp": "2026-02-11 08:03:26.037",
								"UpdatedTimestamp": "2026-02-11 08:03:26.037"
							}
						},
						{
							"itemId": "c93cf847-550c-4756-8158-eb3bcfaedd41",
							"itemType": "customobject",
							"scope": "99-99",
							"version": 1,
							"objectType": "interaction",
							"profileId": "3606f5c3-946d-4ce9-a9de-f5fe0022ea95",
							"properties": {
								"ACM_ActualContactNumber": "6579994374",
								"ACM_AgentComments": "",
								"ACM_AgentID": "Five9@zeniusIt.com",
								"ACM_BlockedBy": "",
								"ACM_CallBackAttemptType": "",
								"ACM_CallBackRequestedBy": "LCM",
								"ACM_CallID": "0aec0cad-64ab-47d6-b7c7-d0836784b6e4",
								"ACM_CallOutcome": 154,
								"ACM_CallReferenceID": "",
								"ACM_CallStartDateTime": "2026-01-29 11:28:42.000",
								"ACM_CallType": 0,
								"ACM_CallbackRegisteredType": 0,
								"ACM_CampaignGroupName": "AW-dev-preview",
								"ACM_CampaignID": "AW-Preview",
								"ACM_Campaignkey": 6,
								"ACM_ChannelType": 2,
								"ACM_ChildListID": 350,
								"ACM_ComputedDurationInMS": 165000,
								"ACM_ConditionID": 38,
								"ACM_ContactId": 299,
								"ACM_ContactNumber": "6579994374",
								"ACM_ContactTries": 1,
								"ACM_CurrentCycle": 1,
								"ACM_CurrentLeadScore": 0,
								"ACM_DNCBussField": "",
								"ACM_DNCCampaignCategoryID": "",
								"ACM_DNCType": 0,
								"ACM_DeliveredTime": "2026-01-29 11:28:52.000",
								"ACM_DeliveredType": "Dialer-Regular",
								"ACM_DialPlanName": "Default_Simple_Strategy",
								"ACM_DialerDateTime": "2026-01-29 11:31:21.000",
								"ACM_DialerId": 10107,
								"ACM_DialingMode": "",
								"ACM_DiallerReferenceID": "300000000142432",
								"ACM_Duration": 159320,
								"ACM_DurationInSeconds": 160,
								"ACM_ICMId": 0,
								"ACM_ICRCallKey": 0,
								"ACM_LCMKey": "299|3|6|0|0|84|1008",
								"ACM_ListID": 104,
								"ACM_ModeId": 3,
								"ACM_NextScheduleMode": "3",
								"ACM_OutcomeDescription": "Busy",
								"ACM_PlatformContactID": "",
								"ACM_PreviewDuration": 0,
								"ACM_PreviousLeadScore": 0,
								"ACM_ReservationCallDuration": 0,
								"ACM_ReservationCallDurationInSeconds": 0,
								"ACM_RouterCallKeySequenceNumber": 0,
								"ACM_SFCampaignId": "0",
								"ACM_SFContactId": "0",
								"ACM_SFLeadId": "0",
								"ACM_SMSTransactionCount": 0,
								"ACM_SkillgroupID": -1,
								"ACM_StateLawGroupName": "",
								"ACM_Status": -1,
								"ACM_StatusChangedAt": "2026-01-29 11:31:26.000",
								"ACM_StatusChangedBy": "0",
								"ACM_StatusReasonId": 71,
								"ACM_TargetAmount": 0,
								"ACM_TargetCampaignGroup": "",
								"ACM_Uploadedtime": "2026-01-29 11:28:28.000",
								"ACM_UserID": "LCM",
								"AcmGid": 0,
								"AcmSfuid": 0,
								"Agent": "Five9@zeniusIt.com",
								"CallDNIS": "+16579994374",
								"CallId": "0aec0cad-64ab-47d6-b7c7-d0836784b6e4",
								"CallStartDateTime": "2026-01-29 11:28:42.000",
								"Channel": "Voice",
								"Direction": "Outbound",
								"Duration": 159320,
								"Id": "c93cf847-550c-4756-8158-eb3bcfaedd41",
								"Identifier": "299|3|6|0|0|84|1008",
								"Outcome": "Busy",
								"ProfileId": "3606f5c3-946d-4ce9-a9de-f5fe0022ea95",
								"Source": "ACM"
							},
							"systemProperties": {
								"CreatedTimestamp": "2026-01-29 11:32:53.535",
								"UpdatedTimestamp": "2026-01-29 11:32:53.535"
							}
						}
					]
				}
			],
			"offset": 0,
			"pageSize": 50,
			"totalSize": 162,
			"sort": [
				"2026-01-22 08:47:03.724"
			]
		}
	}
}

        Was this article helpful?
        What's Next
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout