Number of APIs: 23
This is a collection of 45+ requests for the following Salesforce Data Cloud APIs: Profile API Query API Calculated Insights API Metadata API Ingestion API Segmentation API The collection is divided into 2 API types. Calling APIs directly using the non connect method typically offers the best performance. However, there are use cases where that doesn't make sense. Therefore, please be advised that calling CONNECT APIs directly does not conform to the same SLAs that calling the API directly offers. ⚠️ Disclaimers: ℹ️ Report issues and ask questions here. Follow this documentation to get started with the collection. The collection relies on the following variables: Detail documentation around these variables is available here.
We moved and expanded the Data Cloud Connect REST API Qodex collection to include all of the available methods. The collection now includes examples and reference documentation so that you have the information where and when you need it.
Try out the updated [Salesforce Data Cloud Connect APIs collection here]
Get started
Variables Reference
Variable
Example Value
Description
Used In Direct APIs
Used In Connect APIs
loginUrl
login.salesforce.com
Using login.salesforce.com will be fine unless you are using a sandbox.
X
X
version
52.0
Salesforce API version number
X
clientId
3MVG9l2zHsylwlpR6H5xByqIHvFbLVATgzkY...
Consumer key from the connected app.
X
X
clientSecret
775C20434DB475FC326765353AF5210D4...
Consumer secret from the connected app.
X
privateKey
-----BEGIN RSA PRIVATE KEY----- xxxxxxxx
-----END RSA PRIVATE KEY-----Contents of
host.key
file.X
userName
aaroncates@aaroncates-20210405.demo
User Name of the authorized user.
X
X
password
superSecretPassword1!
Password of the authorized user.
X
securityToken
fVhwzeDFMrAh4IC9hS
Salesforce security token for the authorized user. Details for securing a token available here.
X
GET https://{{dne_cdpOffcoreUrl}}/api/v1/metadata/
GET https://{{dne_cdpOffcoreUrl}}/api/v1/insight/calculated-insights/PurchaseByDate__cio?batchSize=5&dimensions=PurchaseDay__c,CustomerId__c&measures=TotalOrders__c&filters=[CustomerId__c=A003]
GET https://{{dne_cdpOffcoreUrl}}/api/v1/insight/metadata/PurchaseByDate__cio
GET https://{{dne_cdpOffcoreUrl}}/api/v1/insight/metadata
POST https://{{dne_cdpOffcoreUrl}}/api/v1/query
POST
ENDPOINTS