Customer Data Platform Developer Guide

Customer Data Platform Developer Guide
Connect Data
Ingest Data
Model Data
Extract Data
Retrieve Metadata
Search Customer Profile Information
Query Data using Query API V2
Query Data using Query API V1
POST /api/v1/query
Query Source Record IDs
Query Calculated Insights
SQL Guide for Query Service
Customer Data Platform Python Connector
API Limits for Profile, Query, and Calculated Insights
PDF

Query Data using Query API V1

This API family supports only synchronous query API in v1, with 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. This API can be used to support a variety of use cases that include data extraction, external application integration or interactive querying on the data lake.

A newer version of the Query API is available. We recommend using Query V2 API to take advantage of GET calls in addition to POST calls, subsequent requests, and larger response sizes.

Note

Key Properties

  • The call return limit defaults to the max limit of 49,999 rows returned. Use a done flag to check whether more records exist.
  • There is no explicit limit to the SQL call length.
  • There is no explicit limit for the number of nested sub queries.
  • There is no explicit limit for the number of joins.
  • There is no explicit limit for the number of filters.
  • There is no explicit limit for the number of column projections.
  • There is no explicit limit for any specific data type, such as VARCHAR, DECIMAL, or TIMESTAMP.
  • Pagination supported via limit, offset, and orderby parameters.
    • When done is flagged as true in the response, then there are no more records to query. When the response is false, call orderby with offset param to retrieve the next set of numbers.

Connected App Setup

Set Up a Connected App to discover new insights about your customers.

Acquire and Exchange Your Access Token for Salesforce CDP

Refer to Getting Started page to acquire the CDP token.

Call Reference

POST /api/v1/query