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

Replicated Field Input

A field for an Analytics replicated dataset, also known as a connected object.
Properties
Property Name Type Description Required or Optional Available Version
default​Value Object An optional default value. Optional 37.0
description String A long-form description of the field. Optional 37.0
field​Type Connect​Wave​Field​Type​Enum The type of the field. Valid values are:
  • Date
  • Numeric
  • Text

When Analytics custom time zone support is enabled, use DateTime or DateOnly instead of Date.

Note

 Required if the field is new. 37.0
format String For dates, the format string is used to parse the input value; for other field types, the format string is used for display. Optional 37.0
label String A user-friendly label for the field. Optional 37.0
multi​Value Boolean Indicates whether the field is a multivalue field (true) or not (false). The default is false. Optional 37.0
multi​Value​Separator String The value separator, used only if the field is a multivalue field. Optional 37.0
name String The field developer name. Required 37.0
precision Integer The numeric precision or text length depending on field type. Optional 37.0
scale Integer The numeric scale. Optional 37.0
skipped Boolean Indicates whether the field should be skipped on replication (true) or not (false). The default is false. If set to true, this field is ignored when syncing. The field metadata isn’t deleted, however, so the field can be 'unskipped' and made active later. Required 37.0
system​Field Boolean Indicates whether the field is a system field (true) or not (false). The default is false. System fields aren’t queryable. Optional 37.0
uniqueId Boolean Indicates whether the field is a unique ID for the data set (true) or not (false). The default is false. There can only be one unique ID for any dataset. Optional 37.0