CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Quick Start
Examples
Resources
Requests
Responses
Abstract Field
Abstract Lint Item
Action Collection
Action
Advanced Property Value
Advanced Property
Analysis Configuration Outcome
Analytics App Setting Collection
Analytics App Setting
Analytics Asset Collection
Analytics Asset
Analytics Data Asset File
Annotation Collection
Annotation
App Details
App Log
Array Type
Asset History Collection
Asset History
Asset Publishers Collection
Asset Publisher
Asset Reference
Auto-Install App Configuration
Auto-Install Configuration
Auto-Install Request Collection
Auto-Install Request
Base Asset Reference
Base Collection Reference
Base File
Base Notification Action Configuration
Base Object Type
Base Templated Asset
Base Wave Asset
Boolean Type
Bounding Box
Calculated Insight Field Type
Calculated Insight Type
Collaboration Room Notification Recipient
Collection Pin
Collection Subscription Source
Compact Form Column
Compact Form Filter
Compact Form Join Object
Compact Form Join
Compact Form Source
Component Saved View State
Component Saved View
Conditional Formatting Property
Configuration Page Layout
Connection Property Value
Connection Property
Connectors Stats
Connector Type
Contextual Source Asset
Coverage Job
Custom Component Layout
Custom Component Layout Variable
Daily Schedule
Daily Scheduled Item
Dashboard Collection
Dashboard Context Asset
Dashboard Context Location
Dashboard Saved View Collection
Dashboard Saved View Data Source State
Dashboard Saved View Filter
Dashboard Saved View Initial
Dashboard Saved View State
Dashboard Saved View Step Metadata
Dashboard Saved View Step State
Dashboard Saved View
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
Dashboard
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 Job Node Stage Collection
Dataflow Job Node Stage
Dataflow Job Node Stage Parents
Dataflow Node Collection
Dataflow Node
Dataflow
Data Lake Object Field Type
Data Lake Object Type
Data Model Object Field Type
Data Model Object Type
Dataset Any Field Type
Dataset Collection
Dataset Coverage
Dataset Date Type
Dataset Dimension Type
Dataset Measure Type
Dataset Type
Dataset Source
Dataset Version Collection
Dataset Version Reference
Dataset Version
Dataset
Date Time Type
Dependency
Dependency Collection
Directory Item Collection
Display Message
Empty Schedule
Event Driven Schedule
Featured Assets
Group Box Item
Guidance Panel
Header
Hourly Schedule
Geo Data Collection
Geo Data
Image Asset Reference
Image Item
Job Event Collection
Job Event
Json Transformation
Layout
Lens Collection
Lens File
Lens Source Asset
Lens State
Lens
License Attributes
Link Asset Destination
Link Box Item
Literal Json
Live Connection
Macro Definition
Map Collection
Map
Mapped SDM
Minutely Schedule
Monthly Relative Schedule
Monthly Specific Schedule
Navigation Panel
Notification Action
Node Row Count
Number Type
Numeric Separators
Object Coverage
Object Type
Output Source
Page Layout
Page Navigation Info
Page
Page Variable
Panel Item
Panel
Permissions
Post To Slack Notification Action Configuration
Property Condition
Property Option
Query
Replicated Dataset Collection
Replicated Dataset
Replicated Field Collection
Replicated Field
Report Source Asset
Restore Dataset Version
Schedule Details
Schedule
Scheduled Item
Scheduled Time
Scheduled Timezone
Security Predicate
Send To Email Notification Action Configuration
Sharing Inheritance
Single Column Layout
Slack Reference
Snapshot
Sobject Field Type
Sobject Type
Source Field Collection
Source Field
Source Object Collection
Source Object Data
Source Object
Size Limit
String Type
Subscription Collection
Subscription Daily Schedule
Subscription Weekly Schedule
Subscription Schedule
Subscription Source
Subscription
Template Collection
Template Configuration
Template Custom Attributes
Template Icons
Template Lint
Template Lint Item
Template Options
Template Readiness Item
Template Release
Template Release Notes
Template Validate
Template
Text Item
Time
Time Zone
Trended Report Collection
Trended Report
Two Column Layout
Typed Asset Reference
UI Configuration
UI Definition
UI Layout Definition
Unsupported Record Collection
Unsupported Record
User Collection
Validation Page Group
Validation Page Layout
Variable Definition
Variable Item
Variable Item Tile
Variable Type
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 Collection
Wave File Metadata
Wave Folder
Wave Folder Collection
Wave Folder Schedule
Wave Folder Share
Wave User
Weekly Schedule
Weekly Scheduled Item
Widget Subscription Source
Xmd Currency Settings
Xmd Date Field
Xmd Dataset
Xmd Date
Xmd Dimension Custom Action
Xmd Dimension Member
Xmd Dimension Salesforce Action
Xmd Dimension
Xmd Measure Format
Xmd Measure
Xmd Metadata Collection
Xmd Metadata
Xmd Organization
Xmd
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Subscription

An Analytics subscription.
Properties

Subscription inherits properties from the abstract Snapshot. These base properties appear in Subscription alongside the properties defined explicitly in the following table.

Parameter Name Type Description Filter Group and Version Available Version
source Subscription​Source The subscription source including type, label, and record ID. Small, 52.0 52.0