CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Examples
Resources
Requests
Action Input
Advanced Property Value Input
Annotation Input
Asset Reference Input
Asset Revert History Input
Auto-Install App Configuration Input
Auto-Install Configuration
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
Constant Input
Daily Schedule Input
Dashboard Subscription Source Input
Dashboard Widget Item Input
Data Connector Input
Data Connector Property
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
License Attributes Input
Live Connection Input
Macro Input
Map Bounding Box Input
Map 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 Input
Schedule Details 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
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 Input
Wave Collection Item List Input
Wave Collection Pin Input
Wave Folder Input
Wave Folder Share Input
Wave Folder Template Input
Weekly Schedule Input
Widget Subscription Source Input
Xmd Dataset Input
Xmd Date Field Input
Xmd Date 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 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

Newer Version Available

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

Xmd Dimension Input

The extended metadata (Xmd) for a dimension in an Analytics dataset.
Properties
Property Name Type Description Required or Optional Available Version
field String The field name of the dimension (used in queries). Required 36.0
label String The display name for the dataset field. Can be up to 40 characters. Optional 36.0
link​Template String The URL to open when the user clicks the link in the actions menu. Overrides the default URL link, which is /{{row.recordIdField}}. The default finds the Salesforce record with the record ID specified in the recordIdField Xmd parameter. Must be 255 characters or less. To open a Salesforce record from a multi-org environment, enter {{instanceUrl}} to populate the org URL specified in the organizations section of the Xmd. Example: /{{row.dimensionNameId}}. Optional 36.0
link​Template​Enabled Boolean Indicates whether to display the link to open a Salesforce record or URL (true) or not (false). If set to false or not set, the menu doesn't display the Open Record link option. Optional 36.0
link​Tooltip String The tooltip that a dashboard viewer sees when they hover over the link in a Analytics lens or dashboard. Optional 36.0
members Xmd​Dimension​Member​Input[] Any customizations for specific values of the dataset fields. For example, for the "Country" field, change the label of the "USA" to "United States." And change the color for this value in a chart to blue.

When you change the label, the new label only appears in the user interface. You can’t use the label in queries, like a query filter. For this, the best practice is to modify the field values when you create the dataset.

Note

 Optional 36.0
record​Display​Fields String[] An ordered list of dimensions and measures. These dataset fields are used to help a dashboard viewer identify a Salesforce record when multiple records match the action. For each field, specify its API name. In some instances, a dimension value is associated with multiple IDs and isn’t unique. For example, an opportunity with the name “acme” has multiple opportunity IDs (and records). But the action or link can only be directed to one record. Optional 36.0
record​Id​Field String The dataset field that contains the record ID of the Salesforce object that you want to perform the action on. Optional 36.0
record​Organization​Id​Field String The record organization ID for this dimension. Optional 36.0
salesforce​Actions Xmd​Dimension​Salesforce​Action​Input[] The actions that appear in the action menu. You can only add actions that are defined in the page layouts for the corresponding Salesforce object. If left blank, Analytics shows all actions. Optional 36.0
salesforce​Actions​Enabled Boolean Indicates if the Salesforce actions menu is enabled to appear on the field (true) or not (false). If set to false or not set, the menu doesn't display any actions. Required 36.0
show​In​Explorer Boolean Indicates whether the dataset field can be selected from the dashboard designer or explorer when creating dashboards and lenses (true) or not (false). Even if showInExplorer is false, the field can still be used for SAQL queries, manually added in JSON, and accessed using the Analytics REST API. Required 36.0