CRM Analytics REST API Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Abstract Field
Action Collection
Action
Advanced Property Value
Advanced Property
Annotation Collection
Annotation
App Log
Asset Reference
Auto-Install App Configuration
Auto-Install Configuration
Auto-Install Request Collection
Auto-Install Request
Base Asset Reference
Base Collection Reference
Base Notification Action Configuration
Base Wave Asset
Bounding Box
Collaboration Room Notification Recipient
Collection Subscription Source
Compact Form Column
Compact Form Filter
Compact Form Source
Conditional Formatting Property
Connection Property Value
Connection Property
Daily Schedule
Dashboard Snapshot Item Data Row
Dashboard Snapshot Item Last Run
Dashboard Snapshot Item Result
Dashboard Snapshot Item Source Dashboard
Dashboard Snapshot Item
Dashboard Subscription Source
Data Connector Collection
Data Connector Status
Data Connector Type Collection
Data Connector Type
Data Connector
Dataflow Collection
Dataflow Job Collection
Dataflow Job
Dataflow Job Node Collection
Dataflow Job Node
Dataflow Node Collection
Dataflow Node
Dataflow
Dataset Collection
Dataset Coverage
Dataset Source
Dataset Version Collection
Dataset Version Reference
Dataset Version
Dataset
Dependency
Dependency Collection
Directory Item Collection
Display Message
Empty Schedule
Event Driven Schedule
Featured Assets
Hourly Schedule
Geo Data Collection
Geo Data
Image Asset Reference
Json Transformation
License Attributes
Link Asset Destination
Literal Json
Live Connection
Macro Definition
Map Collection
Map
Minutely Schedule
Monthly Relative Schedule
Monthly Specific Schedule
Notification Action
Node Row Count
Numeric Separators
Object Coverage
Output Source
Page
Page Variable
Permissions
Post To Slack Notification Action Configuration
Query
Recipe Collection
Recipe Configuration Collection
Recipe Configuration Fiscal
Recipe Configuration Fiscal Offset
Recipe Configuration
Recipe Conversion Detail
Recipe Definition
Recipe Notification
Recipe Validation Detail
Recipe
Replicated Dataset Collection
Replicated Dataset
Replicated Field Collection
Replicated Field
Restore Dataset Version
Schedule Details
Schedule
Send To Email Notification Action Configuration
Slack Reference
Snapshot
Source Field Collection
Source Field
Source Object Collection
Source Object Data
Source Object
Subscription Collection
Subscription Daily Schedule
Subscription Weekly Schedule
Subscription Schedule
Subscription Source
Subscription
Template Collection
Template Configuration
Template Custom Attributes
Template Icons
Template Options
Template Release
Template Release Notes
Template
Time
Time Zone
Trended Report Collection
Trended Report
Typed Asset Reference
UI Configuration
UI Definition
Unsupported Record Collection
Unsupported Record
User Collection
Variable Definition
Video Info
Visual Parameters
Watchlist Snapshot
Watchlist
Wave Analytics Limit
Wave Analytics Limit Collection
Wave Asset Bundle
Wave Collection
Wave Collection Item
Wave Collection Item List
Wave Collection List
Wave Features
Wave File Metadata
Wave Folder
Wave Folder Collection
Wave Folder Share
Wave User
Weekly Schedule
Widget Subscription Source
Xmd Date Field
Xmd Date
Xmd Dimension Custom Action
Xmd Dimension Member
Xmd Dimension Salesforce Action
Xmd Dimension
Xmd Measure Format
Xmd Measure
Xmd Organization
Xmd
Newer Version Available
CRM Analytics REST API Response Bodies
The successful execution of a request to a CRMAnalytics REST API resource can return a
response body in either JSON or XML format.
A request to a CRM Analytics REST API resource always returns an HTTP response code, whether the request was successful or not.
-
Abstract Field
The base definition of a dataset field. -
Action Collection
A collection of Salesforce actions available to the user. -
Action
A Salesforce action. -
Advanced Property Value
An advanced property name and value pair. -
Advanced Property
An advanced property is a replication property for a data connector source object. -
Annotation Collection
A collection of annotations. -
Annotation
An Analytics annotation. -
App Log
The app log for app creation and updates. -
Asset Reference
An Analytics asset reference. -
Auto-Install App Configuration
The configuration for a auto-install app. -
Auto-Install Configuration
The configuration for a auto-install request. -
Auto-Install Request Collection
A collection of auto-install requests. -
Auto-Install Request
A auto-install request. -
Base Asset Reference
The base Analytics asset. -
Base Collection Reference
The base Analytics collection. -
Base Notification Action Configuration
The base Analytics notification action configuration. -
Base Wave Asset
The base Analytics asset. -
Bounding Box
A bounding box of a map. -
Collaboration Room Notification Recipient
The Slack recipient of a notification. -
Collection Subscription Source
The collection subscription source. -
Compact Form Column
A compact form column. -
Compact Form Filter
A compact form filter. -
Compact Form Source
A compact form source. -
Conditional Formatting Property
The extended metadata (Xmd) for a property in the conditional formatting for an Analytics dataset dimension or measure. -
Connection Property Value
A connection property name and value pair. -
Connection Property
A property used to connect to an Analytics data connector. -
Daily Schedule
Specify a daily schedule for an Analytics asset. -
Dashboard Snapshot Item Data Row
An Analytics dashboard snapshot item data row. -
Dashboard Snapshot Item Last Run
The Analytics dashboard snapshot item last run information. -
Dashboard Snapshot Item Result
An Analytics dashboard snapshot item. -
Dashboard Snapshot Item Source Dashboard
The dashboard source for a dashboard snapshot item. -
Dashboard Snapshot Item
An Analytics dashboard snapshot item. -
Dashboard Subscription Source
The dashboard subscription source. -
Data Connector Collection
A collection of Analytics data connectors. -
Data Connector Status
The status for an Analytics data connector. -
Data Connector Type Collection
A collection of Analytics data connector types. -
Data Connector Type
An Analytics data connector type. -
Data Connector
An Analytics data connector. -
Dataflow Collection
A collection of Analytics dataflows. -
Dataflow Job Collection
A collection of Analytics dataflow jobs. -
Dataflow Job
An Analytics dataflow job. -
Dataflow Job Node Collection
The collection of nodes for an Analytics dataflow job. -
Dataflow Job Node
A node in a dataflow job. -
Dataflow Node Collection
The collection of nodes for an Analytics dataflow. -
Dataflow Node
A node in an dataflow. -
Dataflow
An Analytics dataflow. -
Dataset Collection
A collection of datasets. -
Dataset Coverage
The security coverage for a specific dataset version. -
Dataset Source
The source object used to create a dataset. -
Dataset Version Collection
A collection of versions for an Analytics dataset. -
Dataset Version Reference
The dataset version the coverage information applies to. -
Dataset Version
A specific version of an Analytics dataset. -
Dataset
An Analytics dataset. -
Dependency
An Analytics asset dependency. -
Dependency Collection
A collection of Analytics asset dependencies. -
Directory Item Collection
A collection of directory items. -
Display Message
The display message for an Analytics template. -
Empty Schedule
Specify an empty schedule for an Analytics asset. -
Event Driven Schedule
Specify an event-driven schedule for an Analytics asset. -
Featured Assets
The featured assets. -
Hourly Schedule
Specify an hourly schedule for an Analytics asset. -
Geo Data Collection
A collection of the geo data used by a map. -
Geo Data
The geo data used by a map. -
Image Asset Reference
A image asset for Analytics. -
Json Transformation
The transformed JSON after processing the transformation rules. -
License Attributes
The Analytics license attributes. -
Link Asset Destination
A link to an Analytics asset. -
Literal Json
A string of JSON content results, usually for a query response. -
Live Connection
The connection details of an Analytics live dataset. -
Macro Definition
A macro definition that is part of a larger macro for a JSON transformation rule. -
Map Collection
A collection of maps. -
Map
A map object. -
Minutely Schedule
Specify a schedule that runs multiple times an hour for an Analytics asset. -
Monthly Relative Schedule
Specify a schedule that runs monthly on a relative day within the month for an Analytics asset. -
Monthly Specific Schedule
Specify a schedule that runs monthly on a specific day within the month for an Analytics asset. -
Notification Action
A notification action for an Analytics subscription. -
Node Row Count
The node row count for an Analytics dataflow job node. -
Numeric Separators
The numeric separators for thousands and decimals, used in formatting. -
Object Coverage
The security coverage for a source object. -
Output Source
The output source for an Analytics replicated dataset, also known as a connected object. -
Page
A UI page for an Analytics template. -
Page Variable
An Analytics variable to display on a UI page. -
Permissions
The user permissions for an Analytics asset. -
Post To Slack Notification Action Configuration
The notification action configuration for posting to Slack. -
Query
A query written in SAQL or compact form. -
Recipe Collection
A collection of Analytics data prep recipes. -
Recipe Configuration Collection
A collection of Analytics data prep recipe configurations. -
Recipe Configuration Fiscal
The Analytics data prep recipe fiscal configuration data. -
Recipe Configuration Fiscal Offset
The Analytics data prep recipe fiscal offset configuration data. -
Recipe Configuration
The Analytics data prep recipe configuration data. -
Recipe Conversion Detail
The details for the upconversion of an Analytics data prep recipe. -
Recipe Definition
The definition for an Analytics data prep recipe. Available on for R3 recipes. -
Recipe Notification
A notification for an Analytics data prep recipe. -
Recipe Validation Detail
The validation details for an Analytics recipe. -
Recipe
An Analytics data prep recipe. -
Replicated Dataset Collection
A collection of Analytics replicated datasets, also know as connected objects. -
Replicated Dataset
An Analytics replicated dataset, also know as a connected object. -
Replicated Field Collection
A collection of fields for an Analytics replicated dataset, also known as a connected object. -
Replicated Field
A field for an Analytics replicated dataset, also known as a connected object. -
Restore Dataset Version
The message returned for an Analytics data connector ingest request or an Analytics dataset version update request. -
Schedule Details
The base Analytics schedule details, inherited by SubscriptionDailySchedule and SubscriptionWeeklySchedule. -
Schedule
A schedule on which to execute some type of Analytics asset job. -
Send To Email Notification Action Configuration
The notification action configuration for sending an email. -
Slack Reference
The reference for a Slack entity. -
Snapshot
An Analytics snapshot. -
Source Field Collection
A collection of fields for a source object. -
Source Field
A field for a source object. -
Source Object Collection
A collection of source objects for an Analytics data connector. -
Source Object Data
The data retrieved from a source object given a list of fields and advanced properties. -
Source Object
A source object for an Analytics data connector. -
Subscription Collection
A collection of Analytics subscriptions. -
Subscription Daily Schedule
The daily schedule on which to execute an Analytics subscription. -
Subscription Weekly Schedule
The weekly schedule on which to execute an Analytics subscription. -
Subscription Schedule
An Analytics subscription schedule. -
Subscription Source
The base Analytics subscription source. -
Subscription
An Analytics subscription. -
Template Collection
A collection of Analytics templates. -
Template Configuration
The configuration for an Analytics Template. -
Template Custom Attributes
The custom attributes or metadata for an Analytics template. -
Template Icons
The icons for an Analytics template. -
Template Options
The template options used on the last action performed on a templated Analytics app. -
Template Release
The release information for an Analytics template. -
Template Release Notes
The release notes for an Analytics template. -
Template
An Analytics template. -
Time
The time at which something should happen, usually in relation to an Analytics schedule. -
Time Zone
The time zone in which something should happen, usually in relation to an Analytics schedule. -
Trended Report Collection
A collection of Analytics trended reports. -
Trended Report
An Analytics trended report. -
Typed Asset Reference
A typed Analytics asset reference. -
UI Configuration
Get the Analytics UI configuration data. -
UI Definition
The UI definition for an Analytics template. -
Unsupported Record Collection
The collection of specific records that unsupported for sharing inheritance. -
Unsupported Record
The sharing usage of object instances based on Analytics limits. -
User Collection
Information for a user. Used by the Map representation -
Variable Definition
The variable definition for an Analytics template. Specific variable type responses are listed here. -
Video Info
Information for describing a particular video. -
Visual Parameters
A visual parameters for an Analytics watchlist item. -
Watchlist Snapshot
An Analytics watchlist snapshot collection. -
Watchlist
An Analytics watchlist collection. -
Wave Analytics Limit
An Analytics limit. -
Wave Analytics Limit Collection
The collection of Analytics limits. -
Wave Asset Bundle
The Analytics asset bundled with the associated metadata. -
Wave Collection
A collection of Analytics resources. -
Wave Collection Item
An item in a collection of Analytics resources. -
Wave Collection Item List
A list of items in a collection of Analytics resources. -
Wave Collection List
A list of Analytics collections. -
Wave Features
The Analytics features enabled for a user. -
Wave File Metadata
The metadata for an Analytics file. -
Wave Folder
An Analytics folder. -
Wave Folder Collection
A collection of Analytics folders. -
Wave Folder Share
An Analytics folder sharing rule. -
Wave User
An Analytics user. -
Weekly Schedule
Specify a schedule that runs weekly for an Analytics asset. -
Widget Subscription Source
The widget subscription source. -
Xmd Date Field
The extended metadata (Xmd) for the formatting of date fields. -
Xmd Date
The extended metadata (Xmd) for a date. -
Xmd Dimension Custom Action
The extended metadata (Xmd) for a custom action on an Analytics dataset dimension. -
Xmd Dimension Member
The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset. -
Xmd Dimension Salesforce Action
The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset. -
Xmd Dimension
The extended metadata (Xmd) for a dimension in an Analytics dataset. -
Xmd Measure Format
The extended metadata (Xmd) for the format of a measure in an Analytics dataset. -
Xmd Measure
The extended metadata (Xmd) for a measure in an Analytics dataset. -
Xmd Organization
The extended metadata (Xmd) for an organization in an Analytics dataset. -
Xmd
The extended metadata (Xmd) for an Analytics dataset version.