CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Quick Start
Examples
Resources
Requests
Action Input
Advanced Property Value Input
Analytics App Setting Collection Input
Analytics App Setting Input
Analytics Asset Collection Query Input
Analytics Asset Filter Input
Annotation Input
Asset Reference Input
Asset Revert History Input
Auto-Install App Configuration Input
Auto-Install Configuration Input
Auto-Install Request Insert Input
Auto-Install Request Update Input
Base Asset Input
Base Asset Reference Input
Base Auto-Install Request Input
Base Notification Action Configuration Input
Base Subscription Input
Base Wave Folder Input
Collaboration Room Notification Recipient Input
Collection Subscription Source Input
Component Saved View Input
Component Saved View State Input
Conditional Formatting Property Input
Constant Input
Daily Schedule Input
Daily Scheduled Item Input
Dashboard Input
Dashboard Saved View Data Source State Input
Dashboard Saved View Filter Input
Dashboard Saved View Input
Dashboard Saved View State Input
Dashboard Saved View Step Metadata Input
Dashboard Saved View Step State Input
Dashboard Subscription Source Input
Dashboard Widget Item Input
Data Connector Input
Data Connector Property Input
Dataflow Input
Dataflow Job Input
Dataset Input
Dataset Version Input
Event Based Schedule Input
Featured Assets Input
Geo Data Input
Hourly Schedule Input
Json Transformation Input
Lens Input
Lens State Input
License Attributes Input
Live Connection Input
Macro Input
Map Bounding Box Input
Map Input
Mapped SDM Input
Minutely Schedule Input
Monthly Relative Schedule Input
Monthly Specific Schedule Input
Notification Action Input
Post To Slack Notification Action Configuration Input
Replicated Dataset Input
Replicated Field Collection Input
Replicated Field Input
Restore Dataset Version Input
Rule Definition Input
Rule Input
SAQL Query Input
Schedule Details Input
Schedule Input
Scheduled Item Input
Scheduled Time Input
Scheduled Timezone Input
Send To Email Notification Action Configuration Input
Slack Reference Input
Source Details Input
Source Object Data Input
Subscription Daily Schedule Input
Subscription Input
Subscription Schedule Input
Subscription Source Input
Subscription Weekly Schedule Input
Subscription Widget Input
Template Input
Template Options Input
Template Validate Input
Time Input
Trended Report Input
Typed Asset Reference Input
Visual Parameters Input
Watchlist Input
Watchlist Item Input
Watchlist Item Metadata Input
Watchlist Schedule Input
Wave Collection Input
Wave Collection Item Bulk Add Input
Wave Collection Item Input
Wave Collection Item List Input
Wave Collection Pin Input
Wave Folder Input
Wave Folder Schedule Input
Wave Folder Share Input
Wave Folder Template Input
Weekly Schedule Input
Weekly Scheduled Item Input
Widget Subscription Source Input
Base Xmd Dimension Custom Action Input
Base Xmd Dimension Input
Base Xmd Measure Input
Xmd Currency Settings Input
Xmd Dataset Input
Xmd Date Field Input
Xmd Date Input
Xmd Derived Dimension Custom Action Input
Xmd Derived Dimension Input
Xmd Derived Dimension Member Input
Xmd Derived Dimension Salesforce Action Input
Xmd Derived Measure Format Input
Xmd Derived Measure Input
Xmd Dimension Custom Action Input
Xmd Dimension Input
Xmd Dimension Member Input
Xmd Dimension Salesforce Action Input
Xmd Input
Xmd Measure Format Input
Xmd Measure Input
Xmd Organization Input
Responses
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.

Lens State Input

The state for an Analytics lens.

Properties

Property Name Type Description Required or Optional Available Version
options Lens​Visualization​Options​Input The configuration options for different lens visualizations. Optional 36.0
query Query​Input The SAQL query to be used to create this lens. If using any visualization type other than comparison table, you are required to specify this property. 36.0

Query​Input

Property Name Type Description Required or Optional Available Version
aggregate​Filters Object The compact form aggregate filters for the query. Optional 48.0
column​Groups Object The column groups for the query. Optional 56.0
column​Totals Object The column totals for the query. Optional 56.0
limit Object The query limit. Optional 48.0
orders Object The query orders. Optional 48.0
query String The SAQL query. Optional for PATCH, required for POST 36.0
row​Totals Object The row totals for the query. Optional 56.0
source​Filters Map<String,Compact​Form​Filter​Input> The map of compact form source filters for the query. Optional 48.0
sources Compact​Form​Source​Input[] The list of compact form sources for the query. Optional 48.0
timezone String The timezone for the query request. Optional 43.0
version Double Version to which this query language construct belongs. Optional for PATCH, required for POST 36.0

Compact​Form​Filter​Input

Property Name Type Description Required or Optional Available Version
boolean​Filter​Logic String The boolean filter logic. Optional 49.0
filters Object The compact form filters. Required 48.0

Compact​Form​Source​Input

H
Property Name Type Description Required or Optional Available Version
cogroup​Type Connect​Wave​Compact​Form​Cogroup​Type​Enum The compact form source cogroup type. Valid values are:
  • Anti
  • Inner
  • Left
  • Outer
  • Right
  • Semi
 Required 48.0
columns Compact​Form​Column​Input[] The list of compact form source columns. Required 48.0
groups Object The compact form source groups. Required 48.0
filters Object The compact form source column filters. Required 48.0
name String The compact form source name. Required 52.0

Compact​Form​Column​Input

Property Name Type Description Required or Optional Available Version
field Object The compact form column field Required 48.0
formula String The formula for the compact form column. Required 48.0
name String The name of the compact form column. Required 48.0

Lens​Visualization​Options​Input

Property Name Type Description Required or Optional Available Version
column​Totals Boolean Indicates whether to display column totals in the table (true) or not (false). Optional 55.0
fit Boolean Indicates whether to scale the position and size of data shape so that it’s proportional to its percentage of its category (true) or not (false). Optional 36.0
hide​Header​Column Boolean Indicates whether to display header column (true) or not (false). Optional 36.0
legend Boolean Indicates whether to show legend (true) or not (false). Optional 36.0
legend​Hide​Header Boolean Indicates whether to hide the legend (true) or not (false). Optional 36.0
legend​Width Integer The width of the legend. Optional 36.0
max​Column​Width Integer The maximum width of the header column. Optional 36.0
min​Column​Width Integer The minimum width of the header column. Optional 36.0
miniBars Integer The width of the miniBars, if present. Optional 36.0
multi​Metrics Boolean Indicates whether multiple measures are projected on the same chart, side by side (true) , or if every measure is in its own chart (false). Optional 36.0
normalize Boolean Indicates whether to scale the position and size of data shape so that it’s proportional to its percentage of its category (true) or not (false). Optional 36.0
row​Totals Boolean Indicates whether to display row totals in the table (true) or not (false). Optional 55.0
split​Axis Boolean Indicates whether each measure is projected on one axis or if all measures share an axis (true) or not (false). Optional 36.0
sqrt Boolean Indicates whether the axis is sqrt scale (true) or not (false). Optional 36.0
subtotals Boolean Indicates whether to display subtotals in the table (true) or not (false). Optional 48.0
totals Boolean Indicates whether to display totals in the table (true) or not (false). Optional 36.0
trellis Boolean Indicates whether the last group is treated as a trellis dimension (true) or not (false). Every distinct value of the dimension is a chart. Optional 36.0