Salesforce Docs Portal

CRM Analytics REST API

Using the CRM Analytics REST API, get stage information for dataflow job nodes and filter replicated dataset fields with advanced properties.

New and Changed CRM Analytics REST API Resources

These resources are new or have changes.

Get the stages for a dataflow job node
Make a GET request to the new /wave/dataflowjobs/dataflowjobId/nodes/nodeId/stages resource.
New response body: Dataflow Job Node Stage Collection
Get the stage details for a dataflow job node
Make a GET request to the new /wave/dataflowjobs/dataflowjobId/nodes/nodeId/stages/stageId resource.
New response body: Dataflow Job Node Stage
Get a list of parents for a dataflow job node stage
Make a GET request to the new /wave/dataflowjobs/dataflowjobId/nodes/nodeId/stages/stageId/parents resource.
New response body: Dataflow Job Node Stage Parents
Filter replicated dataset fields using advanced properties
Make a POST request to the /wave/replicatedDatasets/id/fields resource.
Request body includes Source Object Data Input
Response body includes Replicated Field Collection
Filter data connector source object fields using advanced properties
Make a POST request to the /wave/dataConnectors/connectorIdOrApiName/sourceObjects/sourceObjectName/fields resource.
Request body includes Source Object Data Input
Response body includes Source Field Collection

Changed CRM Analytics REST API Request Bodies

These request bodies have changes.

Analytics Asset Collection Query Input

The request body has this new property.

  • archivedScope—the scope for archived assets. Valid values are Active and Archived.
Column Parameters Bar Input

The request body has this new property.

  • hideTotals—the hide totals setting for the table widget column bar.
Column Parameters Text Input

The request body has this new property.

  • hideTotals—the hide totals setting for the table widget column text.
Dashboard Input

The request body has this new property.

  • semanticModels—the list of semantic models, including id, label, and name, associated with the dashboard.
Image Widget Parameters Input

The request body has this new property.

  • decorative—Indicates whether this image is decorative (true) or not (false).

Changed CRM Analytics REST API Response Bodies

These response bodies have changes.

Analytics Asset

The response body has these new properties.

  • lastArchivedBy—the user that last archived the asset.
  • lastArchivedDate—the last date and time when the asset was archived.
Column Parameters Bar

The response body has this new property.

  • hideTotals—the hide totals setting for the table widget column bar.
Column Parameters Text

The response body has this new property.

  • hideTotals—the hide totals setting for the table widget column text.
Dashboard

The response body has this new property.

  • semanticModels—the list of semantic models, including id, label, and name, associated with the dashboard.
Dependency

The response body has this new property.

  • isArchived—Indicates whether this dependency is an archived asset (true) or not (false).
Image Widget Parameters

The response body has this new property.

  • decorative—Indicates whether this image is decorative (true) or not (false).