Extract Data

Programmatically extract your data from Data Cloud.

Retrieve Metadata
Data Cloud Metadata API response includes metadata about all entities, including Calculated Insights, Engagement, Profile, and other entities, as well as their relationships to other objects. For Data Lake Objects (DLOs) and Data Model Objects (DMOs), the API response also includes information about key qualifier fields. For each DLO field and DMO field, the name of the associated key qualifier field is included in the API response.
Query Customer Profile Information with Profile API
Data Cloud Profile API calls are used to look up and search customer profile information. These API calls can be included in your external web or 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 or 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 Data Cloud Calculated Insights object. You can use this API to query Calculated Insights with selected SQL dimensions and measures with optional filters.
CDP Python Connector
Unlock and extend the value of Data Cloud data with the CDP Python Connector. The connector uses the Query API and extracts data from Data Cloud 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 extract data from Data Cloud (formerly Customer Data Platform): Profile, Query, and Calculated Insights.
Webhook Data Action Targets in Data Cloud
Send a Data Cloud 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’s 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.

Data Cloud Developer Guide

Extract Data