Customer Data Platform Developer Guide
jWinter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Retrieve Metadata
Query Services Status Codes
CDP Python Connector
API Limits for Profile, Query, and Calculated Insights
Extract Data
Programmatically extract your data from Customer Data Platform.
-
Retrieve Metadata
Customer Data Platform Metadata API response includes metadata about all entities, including Calculated Insights, Engagement, Profile, and other entities, as well as their relationships to other objects. -
Query Customer Profile Information with Profile API
Customer Data Platform Profile API calls are used to lookup and search customer profile information. These API calls can be included in your external web/mobile apps to look up customer profile information. -
Query Data using Query API V2
Query API V2 supports SQL query in ANSI standard. The results return as an array of records. The expected input when calling this API is free form SQL. The input objects include data stream, profile and engagement data model objects, and unified data model objects. You can use Query API V2 to support a variety of use cases, which includes large volume data reads, external application integration, or interactive on demand querying on the data lake. -
Query Data using Query API V1
The Query API V1 supports SQL query in ANSI standard. The SQL can be a free form SQL with objects that include data streams, profile/engagement data model objects, and unified data model objects. The Query API V1 supports only synchronous calls. You can use the API to support a variety of use cases that include data extraction, external application integration or interactive querying on the data lake. If you don't want to fetch the entire data like in case of browser based clients then you can make a call to the API with limit and offset. -
Query Services Status Codes
Status codes for Query API V1 and Query API V2. -
Query Source Record IDs
Universal ID Lookup API allows you to query on a source record ID from one org and returns the IDs from all orgs. -
Query Calculated Insights
The Calculated Insights API calls only support data collection from the Customer Data Platform Calculated Insights object. You can use this API to query Calculated Insights with selected SQL dimensions and measures with optional filters. -
SQL Guide for Query Service
Customer Data Platform supports ANSI-compliant SQL to formulate queries. Post these queries as requests to Query service and retrieve data from Customer Data Platform. -
CDP Python Connector
Unlock and extend the value of Customer Data Platform data with the CDP Python Connector. The connector uses the Query API and extracts the Customer Data Platform data into Python. It lets you fetch data in Pandas DataFrames. With the data in your environment, you can create visual data models, perform powerful analytical operations, or build powerful machine learning and AI models as well. -
API Limits for Profile, Query, and Calculated Insights
There are three distinct classes of APIs used to extra data from Customer Data Platform: Profile, Query, and Calculated Insights. -
Webhook Data Action Targets in Customer Data Platform
Send a Customer Data Platform data action to a webhook target, and protect the message integrity with a Salesforce-generated secret key. A webhook is a type of HTTP request that is triggered by an event in a source system and sent to a destination system with a payload. A webhook is event-driven rather than request-driven. Webhooks are sent automatically when an event is triggered in the source system. The secret key based signature validates the payload requests sent from Salesforce.