CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Quick Start
Examples
Resources
CRM Analytics REST API Resources Overview
Wave Resource
Actions Resource
Analytics Assets Resources
Annotation Resources
Asset Files Resources
Auto-Install Request Resources
Collection Resources
Dashboard Resources
Data Connector Resources
Data Connector Resource
Data Connectors List Resource
Data Connector Ingest Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Status Resource
Data Connector Types Resource
Dataflow Job Resources
Dataflow Resources
Dataset Resources
Dependencies Resource
Eclair Chart Resources
Features Configuration Resource
Folder Resources
JsonXform Transformation Resource
Limits Resource
Lens Resources
Query Resource
Recipe Resources
Replicated Dataset Resources
Schedule Resource
Subscription Resources
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Template Resources
Trended Report Resources
Watchlist Resources
Xmd Resources
Requests
Responses
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Data Connector Resources

Data connectors are prebuilt connectors to quickly connect to data in your Salesforce orgs, apps, data warehouses, and database services. These resources allow users to manage data connectors and their source objects, run data syncs, and check statuses.
Available resources:
Resource Description Supported HTTP Method Resource URL
Data Connector List Resource Returns a collection of Analytics connectors and creates an Analytics connector. GET POST /wave/dataConnectors
Data Connector Resource Returns Analytics connector properties and updates or deletes Analytics connectors. GET PATCH DELETE /wave/dataConnectors/<connectorId>
Data Connector Ingest Resource Triggers the Analytics connector to run a data sync. This API is the equivalent of the “Run Now” UI feature. POST /wave/dataConnectors/<connectorId>/​ingest
Data Connector Source Objects List Resource Returns a list of all the source objects that are present under the specified CRM Analytics connection. GET /wave/dataConnectors/<connectorId>/​sourceObjects
Data Connector Source Object Resource Returns a source object resource for an Analytics connector. A source object represents a specific category or type of data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. GET /wave/dataConnectors/<connectorId>/​sourceObjects/<sourceObjectName>
Data Connector Source Object Data Preview Resource Returns a preview of the source object data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. GET POST /wave/dataConnectors/<connectorId>/​sourceObjects/<sourceObjectName>/dataPreview
Data Connector Source Object Fields Resource Returns a list of source fields for a particular source object. GET /wave/dataConnectors/<connectorId>/​sourceObjects/<sourceObjectName>/fields
Data Connector Status Resource Tests the status of an external Analytics connector. This API doesn't work to test a local Salesforce connector. GET /wave/dataConnectors/<connectorId>/status
Data Connector Types Resource Returns a collection of Analytics connector types. GET /wave/dataConnectorTypes