Salesforce CRM Analytics Connect API

Number of APIs: 37

This collection lets you access CRM Analytics features such as datasets, dashboards, and lenses programmatically using the CRM Analytics REST API.

Using the CRM Analytics REST API, you can:

  • Send queries directly to the CRM Analytics Platform.
  • Access datasets that have been imported into the CRM Analytics Platform.
  • Validate templates for CRM Analytics apps.
  • Run CRM Analytics dataflows, recipes, and connections. See Run, Schedule, and Sync CRM Analytics Data with REST APIs
  • Retrieve a list of dataflow job nodes and details for each individual node.
  • Access XMD information.
  • Retrieve standard datasets.
  • Retrieve a list of dataset versions.
  • Manipulate synced datasets, also known as connected objects.
  • Work with data connectors.
  • Retrieve recipe metadata.
  • Retrieve collections of CRM Analytics resources.

Get Started

Click the button below and follow the instructions from the following sections:
[Run In Qodex]

  1. Assign a value to the loginUrl collection variable based on your Salesforce Org type:

    Login URLOrg Type
    https://test.salesforce.comSandboxes or Scratch orgs.
    https://login.salesforce.comProduction, Trailhead Playground and Developer Edition orgs.
    Custom My Domain base URLOrg with a custom domain.
  2. Click Get New Access Token from the collection's Authorization tab.

  3. When prompted to do so, log in to your Salesforce org and allow access to Salesforce APIs Collection for Qodex.

  4. Copy the value of the instance_url field from the token details view.

  5. Click Use Token.

  6. Save the value that you copied in the _endpoint variable.

  7. Click Save and you're good to go!

  1. Datasets - getDatasetCollection GET {{baseUrl}}/wave/datasets

  2. Data Connectors - getDataConnectorStatus GET {{baseUrl}}/wave/dataConnectors/:connectorIdOrApiName/status

  3. Dataflows - getDataflow GET {{baseUrl}}/wave/dataflows/:dataflowId

  4. Dataflows - getDataflowCollection GET {{baseUrl}}/wave/dataflows

  5. Dataflow Jobs - getDataflowJobNode GET {{baseUrl}}/wave/dataflowjobs/:dataflowjobId/nodes/:nodeId

  6. Dataflow Jobs - getDataflowJobNodeCollection GET {{baseUrl}}/wave/dataflowjobs/:dataflowjobId/nodes

  7. Data Connectors - getDataConnectorCollection GET {{baseUrl}}/wave/dataConnectors

  8. Dataflow Jobs - getDataflowJobCollection GET {{baseUrl}}/wave/dataflowjobs

  9. Datasets-xmds - getXmd GET {{baseUrl}}/wave/datasets/:datasetIdOrApiName/versions/:versionId/xmds/:xmdType

  10. Data Connectors - getDataConnectorTypeCollection GET {{baseUrl}}/wave/dataConnectorTypes