Data domains
The following domains show where you manage or retrieve each type of data. They are not isolated: a response can include data or IDs from other domains.Three ways APIs expose related data
Data from one domain can appear in another in three ways: as included data, as an ID that points to another resource, or as values stored for a specific record or moment.An API includes related data
Some responses include fields from a related resource. For example, the Agent Chat API returns a customer participant as part of a chat. The participant can include profile information from the Customer Data Platform. Use the included fields when they provide enough information for the resource you are working with. To retrieve or update the related resource itself, use the API that manages it.An API points to another resource
Some responses provide an ID instead of the related resource. For example, an RTM push or webhook can provide achat_id or thread_id without including the complete chat or thread. Use that ID with the Agent Chat API or Customer Chat API to retrieve the related resource.
An API preserves data for its own context
An object can preserve information that applies to a particular time or only to that object. For example:- A ticket requester contains the name and email stored with that ticket.
- Session fields describe the context of a chat session.
- A form event contains the answers submitted in that event.
- An archived conversation can contain customer data that differs from the customer’s Customer Data Platform profile.
How resources connect
Resources from different domains often connect through IDs. Start with the IDs in the response you already have, then use the API that manages the related resource.From a chat
Achat_id identifies the chat that connects participants and threads. A thread_id identifies one conversation session. The customer id on the chat identifies the customer who participated in it.
Use the chat ID to retrieve the chat, the thread ID to retrieve one transcript, and the customer ID to retrieve the customer’s profile:
From a ticket
A ticket source can connect the ticket to the record from which it originated:source.type is integration, source.referenceType names the type of source record, source.referenceID identifies that record, and source.referenceURL links to it. The requester’s name and email remain data stored with the ticket. Ticket responses do not include a Customer Data Platform customer ID.
From a customer
Acustomer_id points to a customer record in the Customer Data Platform. See Customer identities to choose between retrieving that record, data combined across associated identities, or chat and ticket IDs connected to the customer.