Qodex.ai

Salesforce Data Cloud APIs

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.

  • Direct APIs - allows you to perform some of the Salesforce CDP application tasks programmatically via a Direct API to the underlying data store. This is the preferred approach to API connections.
  • Connect APIs - The Connect APIs have moved!
    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]

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:

  • This collection is provided as-is. It's not officially supported by Salesforce or covered by SLAs.
  • API documentation is not provided with the collection. Please refer to the official documentation.
  • To help us better understand usage of the collection, we leverage Google Analytics. If you would like to opt out of the tracking, you can remove the Pre-request Script set at the collection level.

ℹ️ Report issues and ask questions here.

Get started

Follow this documentation to get started with the collection.

Variables Reference

The collection relies on the following variables:

VariableExample ValueDescriptionUsed In Direct APIsUsed In Connect APIs
loginUrllogin.salesforce.comUsing login.salesforce.com will be fine unless you are using a sandbox.XX
version52.0Salesforce API version numberX
clientId3MVG9l2zHsylwlpR6H5xByqIHvFbLVATgzkY...Consumer key from the connected app.XX
clientSecret775C20434DB475FC326765353AF5210D4...Consumer secret from the connected app.X
privateKey-----BEGIN RSA PRIVATE KEY----- xxxxxxxx
-----END RSA PRIVATE KEY-----		Contents of host.key file.X
userNameaaroncates@aaroncates-20210405.demoUser Name of the authorized user.XX
passwordsuperSecretPassword1!Password of the authorized user.X
securityTokenfVhwzeDFMrAh4IC9hSSalesforce security token for the authorized user. Details for securing a token available here.X

Detail documentation around these variables is available here.

  1. Direct APIs-Metadata API - Metadata GET https://{{dne_cdpOffcoreUrl}}/api/v1/metadata/

  2. Direct APIs-Calculated Insights API - Query Calculated Insights 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]

  3. Direct APIs-Calculated Insights API - Metadata - Individual Calculated Insight GET https://{{dne_cdpOffcoreUrl}}/api/v1/insight/metadata/PurchaseByDate__cio

  4. Direct APIs-Calculated Insights API - Metadata - All Calculated Insights GET https://{{dne_cdpOffcoreUrl}}/api/v1/insight/metadata

  5. Direct APIs-Query API - Query POST https://{{dne_cdpOffcoreUrl}}/api/v1/query

  6. Direct APIs-Ingestion API-Streaming - Insert Records POST https://{{dne_cdpOffcoreUrl}}/api/v1/ingest/sources/Event_API/runner_profiles

  7. Direct APIs-Ingestion API-Streaming - Delete Records DELETE https://{{dne_cdpOffcoreUrl}}/api/v1/ingest/sources/Event_API/runner_profiles?ids=101

  8. Direct APIs-Ingestion API-Streaming - Sync Record Validation POST https://{{dne_cdpOffcoreUrl}}/api/v1/ingest/sources/Event_API/runner_profiles/actions/test

  9. Direct APIs-Ingestion API-Bulk - Create Job POST https://{{dne_cdpOffcoreUrl}}/api/v1/ingest/jobs

  10. Direct APIs-Ingestion API-Bulk - Upload Job PUT https://{{dne_cdpOffcoreUrl}}/api/v1/ingest/jobs/fcf98ed6-d514-4923-8369-486f7dad4359/batches