Upload
dinhnhu
View
298
Download
5
Embed Size (px)
Citation preview
Analytics REST API DeveloperGuide
Salesforce, Spring ’18
@salesforcedocsLast updated: March 22, 2018
© Copyright 2000–2018 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS
WORKING WITH THE ANALYTICS REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Analytics REST API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Analytics REST API Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
ANALYTICS REST API REFERENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Analytics REST API Resources Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Wave Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Annotations List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Annotation Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Charts Geodata List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Charts Geodata Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Charts Geodata File List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Charts Maps List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Charts Maps Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Dashboards List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Dashboard Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Dashboard Image Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Dashboard Saved Views List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Dashboard Saved Views Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Dashboard Saved Views Initial Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Data Connector Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Data Connectors List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Data Connector Source Objects List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Data Connector Source Object Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Data Connector Source Object Data Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Data Connector Source Object Data Preview Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Data Connector Source Object Fields Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Data Connector Types Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Dataflow Jobs List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Dataflow Jobs Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Dataflows List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Dataflows Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Datasets List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Dataset Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Dependencies Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Features Configuration Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92File Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Folders List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Folder Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Lenses List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Lens Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Lens File Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Lens File Metadata Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Query Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Recipes List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Recipe Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Recipe File Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Replicated Datasets Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Replicated Datasets List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Replicated Dataset Fields Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Security Coverage Dataset Version Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Security Coverage Object Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Templates List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Templates Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Templates Configuration Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Template Release Notes Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Trended Reports List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Trended Reports Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Dataset Versions List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Dataset Version Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163XMD List Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166XMD Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Contents
WORKING WITH THE ANALYTICS REST API
Analytics REST API Overview
You can access Analytics features such as datasets, dashboards and lenses programmatically using the Analytics REST API.
Using the Analytics REST API, you can:
• Send queries directly to the Analytics Platform.
• Access datasets that have been imported into the Analytics Platform.
• Create and retrieve Analytics lenses.
• Access XMD information.
• Retrieve a list of dataset versions.
• Create and retrieve Analytics applications.
• Create, update, and retrieve Analytics dashboards.
• Retrieve a list of dependencies for an application.
• Determine what features are available to the user.
• Work with and schedule Trend in Analytics report snapshots.
• Manipulate replicated datasets.
• Get, add, update, and delete ‘eclair’ geo map charts.
• Work with data connectors.
• Retrieve or update recipes.
• Discover whether objects and particular dataset versions have support for sharing inheritance.
The Analytics REST API is based on the Chatter REST API and follows its conventions. For more information about the Chatter REST API,see the Chatter REST API Developer Guide.
Important: The internal API, that was previously used in the Analytics user interface, also labeled as private and for Salesforceonly, is not supported. This internal API will be depricated, as first noted in API version 36. Clients using this internal private APIwill not have access to any newly created or updated dashboard assets created using tools in the latest release. We encouragedevelopers of such clients to port them to the Analytics API GA.
Analytics REST API Authentication
Salesforce uses the OAuth protocol to allow users of applications to securely access data without having to reveal username and passwordcredentials.
The following sections introduce authentication and provide the steps you need to follow to set up authorization and connect to AnalyticsREST API using OAuth.
Understanding AuthenticationBefore making API calls using the Analytics API, you must authenticate the application user using OAuth 2.0. To do so, you’ll need to dothe following:
1
• Set up your application as a connected app in the Salesforce organization.
• Determine the correct Salesforce OAuth endpoint for your connected app to use.
• Authenticate the connected app user via one of several different OAuth 2.0 authentication flows. An OAuth authentication flowdefines a series of steps used to coordinate the authentication process between your application and Salesforce. Supported OAuthflows include the following:
– Web server flow, where the server can securely protect the consumer secret.
– User-agent flow, used by applications that cannot securely store the consumer secret.
– Username-password flow, where the application has direct access to user credentials.
Set Up AuthorizationCreate a connected app in a Salesforce organization and enable OAuth. The client application uses the connected app to connect toSalesforce.
1. In your Salesforce organization, from Setup, click Create | Apps , and in the Connected Apps section, click New to create a newconnected app.
2. Clients can use a connected app to sign in to any organization, even if the connected app isn’t defined in that organization.
3. Enter a connected app name.
4. Select Enable OAuth Settings.
5. Enter a Callback URL. It must be secure: use https:// and not http://.
6. Enter an OAuth scope. Select Access and manage your data (api) in addition to any other scope you want yourconnected app to allow access to.
7. Click Save.
8. The Consumer Key is created and displayed, and a Consumer Secret is created (click the link to reveal it).
Connect to Analytics REST API Using OAuthUse OAuth to connect to Salesforce and get an access token. Pass the access token in requests to Analytics API.
This table maps the terms used in the connected app you created to the OAuth properties used in the examples. The OAuth 2.0specification uses the word “client” instead of “consumer.”
Value in ExampleConnected App Application Label
client_id KeyConsumer Key
client_secretConsumer Secret
Note: The instructions here use the username-password OAuth authentication flow. The username-password authenticationflow passes the user’s credentials back and forth. Use this authentication flow only when necessary. No refresh token will be issued.
To make a request to Salesforce, substitute values from your organization into these examples:
1. Generate the access token.
2
Analytics REST API AuthenticationWorking with the Analytics REST API
This cURL command generates an access token:
curl --formclient_id=3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9
--form client_secret=8870355475032095511--form grant_type=password--form [email protected] password=1Lsfdc!
https://login.salesforce.com/services/oauth2/token
Note: To paste a multiline command into a Mac or Linux command line interface, escape each line with a backslash ( \ ) toindicate that the command continues on the next line. An escaped line looks like this:
curl --form client_id=3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9 \
To paste a multi-line command into the Windows Command Prompt, escape each line with a caret ( ^ ). An escaped linelooks like this:
curl --form client_id=3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9 ^
The response includes the server instance and the access token:
{"id":"https://login.salesforce.com/id/00Di0000000hT9uEAE/005i00000022uIbAAI","issued_at":"1302907727777","instance_url":"https://yourInstance.salesforce.com","signature":"5jcevY5fUai0lWntuSxkwBzWcvRjd01RCOkIBZpyGv0=","access_token":"00DD0000000FJ6T!AQkAQPde_DMF2vGzddfZmBRS95GojDbtA
rKkgukAgZP0OVFYY5KkAqhLw9ejeKIlpJ3FgwGAWeRlBiWRt8mfXEuAZGbZNosk"}
2. To request an Analytics REST API resource, use the returned instance_url as the server instance. Pass the returned access_token asa Bearer token in the Authorization request header.
curl -X GET https://yourInstance.salesforce.com/services/data/v42.0/wave-H 'Authorization: Bearer 00DD0000000FJ6T!AQkAQPde_DMF2vGzddfZmBRS95GojDbtArKkgukAgZP0OVFYY5KkAqhLw9ejeKIlpJ3FgwGAWeRlBiWRt8mfXEuAZGbZNosk'
Value in ExampleProperty
yourInstance.salesforce.comServer instance
3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9client_id
8870355475032095511client_secret
password
The value of grant_type depends on the OAuth authenticationflow you use
grant_type
1Lsfdc!password
3
Analytics REST API AuthenticationWorking with the Analytics REST API
ANALYTICS REST API REFERENCE
Analytics REST API Resources Overview
The Analytics REST API provides resources so you can access your Analytics data.
All Analytics REST API resources are accessed using:
• A base URL for your company (for example, https://yourInstance.salesforce.com)
• Version information (for example, /services/data/v42.0)
• A named resource (for example, /wave)
Put together, an example of the full URL to the resource is:
https://yourInstance.salesforce.com/services/data/v42.0/wave
Org and Object Identifiers
Id fields in Salesforce, and in the Analytics UI, are typically 15-character, base-62, case-sensitive strings. This is true of JSON XMD too.However, many Salesforce APIs, including the Analytics REST API, use 18-character, case-insensitive strings—for example, the Id propertyof the Dataset resource/wave/datasets/<dataset ID>. The last three digits are a checksum of the preceding 15 characters.The use of case-insensitive Id’s eases interaction with external applications and development environments that use case-insensitivereferences. To convert an 18-character Id back to a 15-character ID, simply remove the last three characters.
Resource URLSupportedHTTPMethod
DescriptionResource
/waveGETLists the top-level resources available forAnalytics.
Wave Resource
/wave/queryPOSTExecutes a query written in Salesforce AnalyticsQuery Language (SAQL).
Query Resource
/wave/datasetsGETReturns a list of Analytics datasets.Datasets ListResource
/wave/datasets/<dataset ID>GET,DELETE,PATCH
Returns the Analytics dataset with the specifiedID, deletes a dataset (DELETE), or updates adataset (PATCH).
DatasetResource
/wave/datasets/<dataset ID>/versions
GETReturns a collection of dataset versions for aparticular dataset.
Dataset VersionsList Resource
/wave/datasets/<dataset ID>/versions/<version ID>
GET,PATCH
Returns an Analytics dataset version (GET), orupdates the predicate (PATCH).
Dataset VersionResource
/wave/datasets/<dataset ID>/versions/<version ID>/files/<file ID>
GETProvides access to the binary content of thedataset file.
File Resource
4
Resource URLSupportedHTTPMethod
DescriptionResource
/wave/datasets/<dataset ID>/versions/<version ID>/xmds
GETReturns a list of XMD resources for a version of adataset.
XMD ListResource
/wave/datasets/<dataset ID>/versions/<version ID>/xmds/<XMDtype>
GET, PUTReturns the extended metadata (XMD) for aversion of a dataset (GET) and replaces the userXMD file (PUT).
XMD Resource
/wave/lensesGET, POSTReturns a list of Analytics lenses (GET), or createsa lens (POST).
Lenses ListResource
/wave/lenses/<lens ID>GET,DELETE,POST
Returns a JSON file that describes the structureof an Analytics lens with the specified ID (GET),deletes a lens (DELETE), or updates a lens (PATCH).
Lens Resource
/wave/lenses/<lenses ID>/files/<files ID>
GET, PUTReturns a file that is part of an Analytics lens.Lens FileResource
/wave/dashboardsGET, POSTReturns a list of Analytics dashboards, or createsa dashboard.
Dashboards ListResource
/wave/dashboards/<dashboard ID>GET,DELETE,PATCH
Returns or updates the dashboard with thespecified ID or API name.
DashboardResource
GETDELETE
Work with saved views.DashboardSaved ViewsResources
• /wave/dashboards/<dashboard IDor API name>/savedviews
PATCHPOST • /wave/dashboards/<dashboard ID
or API name>/savedviews/<ViewID>
• /wave/dashboards/<dashboard IDor API name>/savedviews/initial
/wave/dependencies/<folder ID>GETReturns the dependencies for an asset.DependenciesResource
/wave/foldersGET, POSTCreates an Analytics application (POST), which isa folder that contains Analytics datasets, lenses,
Folders ListResource
and dashboards, or returns a collection ofapplications or folders (GET).
/wave/folders/<folder ID>GET, PUT,PATCH,DELETE
Returns the representation for an Analyticsapplication or folder (GET), replaces an applicationor folder (PUT), updates it (PATCH), or deletes it(DELETE).
Folder Resource
5
Analytics REST API Resources OverviewAnalytics REST API Reference
Resource URLSupportedHTTPMethod
DescriptionResource
/wave/replicatedDatasets/<ID>GET,PATCH,DELETE
Replicates data from an external Source Objectinto an Analytics as a dataset. Replicated Datasetsare not intended to be visualized directly, but areused like a cache to speed up other workflowswhich refer to the same source object.
ReplicatedDatasetsResource
wave/replicatedDatasetsGET, POSTReturns a list of replicated datasets.ReplicatedDatasets ListResource
/wave/replicatedDatasets/<ID>/fieldsGET,PATCH
A list of Replicated Fields for a particularReplicated Dataset.
ReplicatedDataset FieldsResource
/wave/templatesGETReturns a list of Analytics templates, or adds atemplate.
Templates ListResource
/wave/templates/<templateIdOrApiName>
GETReturns a list of Analytics templates, or adds atemplate.
TemplatesResource
/wave/templates/<templateIdOrApiName>/configuration
GETReturns the configuration of an Analyticstemplate.
TemplatesConfigurationResource
/wave/trendedreportsGET, POSTReturns or adds to a collection of TrendingReports.
Trended ReportsList Resource
/wave/trendedreports/<Id>DELETE,GET,PATCH
Returns, deletes, or updates a Trending Report.Trended ReportsResource
/wave/lenses/<lensId>/filesGET, POSTResource for management of Analytics lens filemetadata.
Lens FileMetadataResource
/wave/config/featuresGETThe Analytics features that are available to a user.FeaturesConfigurationResource
/wave/annotationsGET, POSTA collection of annotations.Annotations ListResource
/wave/annotations/<Annotation ID>GET,PATCH
An asset's annotations.AnnotationsResource
/wave/templates/<templateIdOrApiName>/releasenotesGETResource for retrieving the release notes for asingle Analytics Template.
TemplateRelease NotesResource
/eclair/mapsGET POSTGet the collection of maps, or post a new map.Charts Maps ListResource
6
Analytics REST API Resources OverviewAnalytics REST API Reference
Resource URLSupportedHTTPMethod
DescriptionResource
/eclair/maps/<id>DELETEGETPATCH
Get, update, or delete a specific map.Charts MapsResource
/eclair/geodata/<id>DELETEGETPATCH
Get, update, or delete a specific geodatadefinition.
Charts GeodataResource
/eclair/geodataGET POSTGet the collection of geodata definitions, or posta new one.
Charts GeodataList Resource
/eclair/geodata/<id>/fileGETGet the binary file associated with a geodatadefinition.
Charts GeodataFile List Resource
GETDELETE
Work with data connectors.Data ConnectorResources
• /wave/dataConnectors
• /wave/dataConnectors/<connectorId>PATCHPOST • /wave/dataConnectors/<connectorId>/
sourceObjects
• /wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>
• /wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>/data
• /wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>/dataPreview
• /wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>/fields
• /wave/dataConnectorTypes
GETDELETEPATCH
Retrieve or update recipes.RecipeResources
• /wave/recipes
• /wave/recipes/<id>
• /wave/recipes/<id>/file
GET POSTPATCH
Work with dataflows.DataflowsResources
• /wave/dataflows
• /wave/dataflows/<dataflowId>
GET POSTPATCH
Work with dataflow jobs.Dataflow JobsResources
• /wave/dataflowjobs
• /wave/dataflowjobs/<dataflowjob ID>
GETDiscover whether objects and particular datasetversions have support for sharing inheritance.
SecurityResources
• /wave/security/coverage/datasets/<datasetIdOrApiName>/versions/<versionId>
7
Analytics REST API Resources OverviewAnalytics REST API Reference
Resource URLSupportedHTTPMethod
DescriptionResource
• /wave/security/coverage/objects/<objectApiName>
Filtering REST ResponsesReturns the representation for an Analytics application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), ordeletes it (DELETE).
In addition to Analytics REST API input parameters, you can use the following Chatter REST API input parameters to filter the resultsreturned from a request: filterGroup, external, and internal. For more information, see Specifying Response Sizes in theChatter REST API Developer Guide.
Wave Resource
Lists the top-level resources available for Analytics.
Resource URL
/wave
FormatsJSON
Available Version36.0
HTTP MethodsGET
GET Response Body
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The URL to the datasets resource for the organization.Stringdatasets
36.0Small, 36.0The URL to the lenses resource for the organization.Stringlenses
36.0Small, 36.0The URL to the query resource for the organization.Stringquery
Example Response Body
{"datasets" : "/services/data/v42.0/wave/datasets","lenses" : "/services/data/v42.0/wave/lenses","query" : "/services/data/v42.0/wave/query"
}
8
Wave ResourceAnalytics REST API Reference
Annotations List Resource
A collection of annotations.
Resource URL
/wave/annotations
FormatsJSON
Available Version37.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0RequiredThe ID of the asset.IdassetId
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0The list of annotations for this asset andfeedSubject.
AnnotationRepresentation onpage 10[]
annotations
37.0Small, 37.0The feed subject for all annotations.AssetReferenceRepresentation onpage 88
feedSubject
38.0Small, 38.018-character ID of the subscription.StringsubscriptionId
37.0Small, 37.0URL to get this collection.Stringurl
POST Request BodyAnnotationInputRepresentation on page 10
POST Response BodyAnnotationRepresentation on page 10
Annotation Resource
An asset's annotations.
9
Annotations List ResourceAnalytics REST API Reference
Resource URL
/wave/annotations/<Annotation ID>
FormatsJSON
Available Version37.0
HTTP MethodsGET PATCH
GET Response BodyAnnotationRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0The anchor key.Stringanchor
37.0Small, 37.0The referenced asset.AssetReferenceRepresentation onpage 88
asset
37.0Small, 37.0The referenced feed element.AssetReferenceRepresentation onpage 88
feedElement
37.0Small, 37.0The 18 character annotation ID.Stringid
37.0Small, 37.0The resolved state of the annotation.Booleanresolved
37.0Small, 37.0URL to get this annotation.Stringurl
PATCH Request BodyAnnotationInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0OptionalThe anchor of the annotation.Stringanchor
37.0RequiredThe referenced asset of the annotation.AssetReferenceInputRepresentationon page 41
asset
37.0RequiredThe referenced feed element of theannotation.
AssetReferenceInputRepresentationon page 41
feedElement
37.0OptionalThe resolved state of the annotation.Booleanresolved
10
Annotation ResourceAnalytics REST API Reference
PATCH Response BodyAnnotationRepresentation on page 10
Charts Geodata List Resource
Get the collection of geodata definitions, or post a new one.
Resource URL
/eclair/geodata
FormatsJSON
Available Version38.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
38.0The page number you want to view.Intpage
38.0How many items you want to view oneach page, up to 500.
IntpageSize
GET Response BodyGeoDataCollectionRepresentation
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0The geojson file you want to upload.BinarygeoDataFile
39.0List of all relevant information about theGeoData, i.e. { "label": "My GeoData" }.
Object(GeoDataInputRepresentation)
geoDataObject
POST Request BodyGeoDataInputRepresentation
POST Response BodyGeoDataRepresentation
11
Charts Geodata List ResourceAnalytics REST API Reference
GeoDataCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0A list of the geodata.GeoDataRepresentation[]
geoData
GeoDataRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0The ID of this geo data record.Stringid
38.0Small, 38.0The user set name for the geo data.Stringlabel
38.0Small, 38.0The developer name for the geo data.Stringname
39.0Small, 39.0The namespace of the geo data.Stringnamespace
38.0Small, 38.0The type of geo data (currently justGeoJSON).
ConnectEclairGeoDataTypeEnum
type
38.0Small, 38.0The url to retrieve the geodata.Stringurl
GeoDataInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Sets the GeoData label.Stringlabel
39.0Sets the GeoData developer name.Stringname
Example curl request to create a geodata resource from a GeoJson file
curl -H "X-PrettyPrint: 1" \-F 'json={"label": "GeoJsonLabel","name": "<developer_name>"};type=application/json'\-F "[email protected]" \-X POST \https://yourinstanceurl/services/data/v39.0/eclair/geodata \-H 'Authorization: OAuth Oauth Token'
Example Response Body
{"id" : "05oP0000000000LIAQ","label" : "GeoJsonLabel","name" : "<developer_name>","type" : "geojson",
12
Charts Geodata List ResourceAnalytics REST API Reference
"url" : "/services/data/v39.0/eclair/geodata/05oP0000000000LIAQ/file"}
Charts Geodata Resource
Get, update, or delete a specific geodata definition.
Resource URL
/eclair/geodata/<id>
FormatsJSON
Available Version38.0
HTTP MethodsDELETE GET PATCH
GET Response BodyGeoDataRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0The ID of this geo data record.Stringid
38.0Small, 38.0The user set name for the geo data.Stringlabel
38.0Small, 38.0The developer name for the geo data.Stringname
39.0Small, 39.0The namespace of the geo data.Stringnamespace
38.0Small, 38.0The type of geo data (currently justGeoJSON).
ConnectEclairGeoDataTypeEnum
type
38.0Small, 38.0The url to retrieve the geodata.Stringurl
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0The geojson file you want to upload.BinarygeoDataFile
39.0List of all relevant information about theGeoData, i.e. { "label": "My GeoData" }.
Object(GeoDataInputRepresentation)
geoDataObject
PATCH Request BodyGeoDataInputRepresentation
13
Charts Geodata ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Sets the GeoData label.Stringlabel
39.0Sets the GeoData developer name.Stringname
PATCH Response BodyGeoDataRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0The ID of this geo data record.Stringid
38.0Small, 38.0The user set name for the geo data.Stringlabel
38.0Small, 38.0The developer name for the geo data.Stringname
39.0Small, 39.0The namespace of the geo data.Stringnamespace
38.0Small, 38.0The type of geo data (currently justGeoJSON).
ConnectEclairGeoDataTypeEnum
type
38.0Small, 38.0The url to retrieve the geodata.Stringurl
Charts Geodata File List Resource
Get the binary file associated with a geodata definition.
Resource URL
/eclair/geodata/<id>/file
FormatsJSON
Available Version38.0
HTTP MethodsGET
GET Response BodyStreamedRepresentation. Returns a binary stream of the contents of the specified file.
Charts Maps List Resource
Get the collection of maps, or post a new map.
Resource URL
/eclair/maps
14
Charts Geodata File List ResourceAnalytics REST API Reference
FormatsJSON
Available Version38.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
38.0The page number you want to view.Intpage
38.0How many items you want to view oneach page, up to 500.
IntpageSize
GET Response Body
MapCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0The list of the collection.MapRepresentation[]
maps
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0List of all relevant information about themap, i.e. { "label": "My Map" }.
Object(MapInputRepresentation)
geoMapObject
POST Request Body
MapInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Sets the Map bounding box.MapBoundingBoxInputRepresentation
boundingBox
39.0Sets the parent GeoData.AssetReferenceInputRepresentation
geoData
39.0Sets the Map label.Stringlabel
39.0Sets the Map nameStringname
15
Charts Maps List ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Sets the Map projection (AlbersUSA,Equirectangular, or Mercator)
ConnectEclairMapProjectionTypeEnum
projection
POST Response Body
MapRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 38.0The bounding box of the geo mapBoundingBoxRepresentation
boundingBox
38.0Small, 38.0The creator of the mapUserRepresentationcreatedBy
38.0Small, 38.0The date when this map was createdDatecreatedDate
38.0Small, 38.0The geo data of the mapGeoDataRepresentation
geoData
38.0Small, 38.0The 18 character user IDStringid
39.0Small, 39.0The label of the mapStringlabel
39.0Small, 39.0The name of the mapStringname
39.0Small, 39.0The namespace of the mapStringnamespace
38.0Small, 38.0The projection used by the map(AlbersUSA, Equirectangular, or Mercator)
ConnectEclairMapProjectionTypeEnum
projection
38.0Small, 38.0The url to the map representationStringurl
MapBoundingBoxInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0RequiredThe bottom boundary of the geo mapDoublebottom
39.0RequiredThe left boundary of the geo mapDoubleleft
39.0RequiredThe right boundary of the geo mapDoubleright
39.0RequiredThe top boundary of the geo mapDoubletop
16
Charts Maps List ResourceAnalytics REST API Reference
BoundingBoxRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The bottom boundary of the geo mapDoublebottom
39.0Small, 39.0The left boundary of the geo mapDoubleleft
39.0Small, 39.0The right boundary of the geo mapDoubleright
39.0Small, 39.0The top boundary of the geo mapDoubletop
UserRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0The 18 character user IDStringid
38.0Small, 38.0The name of the userStringname
Example curl request (without bounding boxes)
curl -H "X-PrettyPrint: 1" \-d '{"geoData": {"id": "<id_of_geodata_resource>"},"name":"<developer_name_for_map>","label": "<display_label_for_map>","projection":"equirectangular"}' \-F "[email protected]" \-X POST \https://yourinstanceurl/services/data/v39.0/eclair/geodata \-H 'Authorization: OAuth Oauth Token'
Example Response Body
{"boundingBox": {},"createdBy": {
"id": "005G0000004KRG3IAO","name": "Anand B Narasimhan"
},"createdDate": "2017-03-06T13:18:53.000Z","geoData": {
"id": "05oP0000000000BIAQ","label": "PA_Territories","name": "PA_Territories","type": "geojson","url": "/services/data/v39.0/eclair/geodata/05oP0000000000BIAQ/file"
},"id": "05pP0000000000aIAA","label": "map_lable","name": "map_name","projection": "equirectangular",
17
Charts Maps List ResourceAnalytics REST API Reference
"url": "/services/data/v39.0/eclair/maps/05pP0000000000aIAA"}
Example curl request (with bounding boxes)
curl -H "X-PrettyPrint: 1" \-d '{"boundingBox": {"bottom": 40.5534,"left": -80.251,"right": -79.8211,"top":40.3287},\"geoData": {"id": "id_of_geodata_resource"},"name": "<developer_name_for_map>",\"label": "<display_label_for_map>","projection": "equirectangular"}' \-F "[email protected]" \-X POST \https://yourinstanceurl/services/data/v39.0/eclair/geodata \-H 'Authorization: OAuth Oauth Token'
Example Response Body
{"boundingBox": {
"bottom": 40.5534,"left": -80.251,"right": -79.8211,"top": 40.3287
},"createdBy": {
"id": "005G0000004KRG3IAO","name": "Anand B Narasimhan"
},"createdDate": "2017-03-06T13:18:53.000Z","geoData": {
"id": "05oP0000000000BIAQ","label": "PA_Territories","name": "PA_Territories","type": "geojson","url": "/services/data/v39.0/eclair/geodata/05oP0000000000BIAQ/file"
},"id": "05pP0000000000aIAA","label": "map_label","name": "map_name","projection": "equirectangular","url": "/services/data/v39.0/eclair/maps/05pP0000000000aIAA"
}
Charts Maps Resource
Get, update, or delete a specific map.
Resource URL
/eclair/maps/<id>
FormatsJSON
18
Charts Maps ResourceAnalytics REST API Reference
Available Version38.0
HTTP MethodsDELETE GET PATCH
GET Response Body
MapRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 38.0The bounding box of the geo mapBoundingBoxRepresentation
boundingBox
38.0Small, 38.0The creator of the mapUserRepresentationcreatedBy
38.0Small, 38.0The date when this map was createdDatecreatedDate
38.0Small, 38.0The geo data of the mapGeoDataRepresentation
geoData
38.0Small, 38.0The 18 character user IDStringid
39.0Small, 39.0The label of the mapStringlabel
39.0Small, 39.0The name of the mapStringname
39.0Small, 39.0The namespace of the mapStringnamespace
38.0Small, 38.0The projection used by the map(AlbersUSA, Equirectangular, or Mercator)
ConnectEclairMapProjectionTypeEnum
projection
38.0Small, 38.0The url to the map representationStringurl
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0List of all relevant information about themap, i.e. { "label": "My Map" }.
Object(MapInputRepresentation)
geoMapObject
PATCH Request Body
MapInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Sets the Map bounding box.MapBoundingBoxInputRepresentation
boundingBox
19
Charts Maps ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Sets the parent GeoData.AssetReferenceInputRepresentation
geoData
39.0Sets the Map label.Stringlabel
39.0Sets the Map nameStringname
39.0Sets the Map projection (AlbersUSA,Equirectangular, or Mercator)
ConnectEclairMapProjectionTypeEnum
projection
PATCH Response Body
MapRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 38.0The bounding box of the geo mapBoundingBoxRepresentation
boundingBox
38.0Small, 38.0The creator of the mapUserRepresentationcreatedBy
38.0Small, 38.0The date when this map was createdDatecreatedDate
38.0Small, 38.0The geo data of the mapGeoDataRepresentation
geoData
38.0Small, 38.0The 18 character user IDStringid
39.0Small, 39.0The label of the mapStringlabel
39.0Small, 39.0The name of the mapStringname
39.0Small, 39.0The namespace of the mapStringnamespace
38.0Small, 38.0The projection used by the map(AlbersUSA, Equirectangular, or Mercator)
ConnectEclairMapProjectionTypeEnum
projection
38.0Small, 38.0The url to the map representationStringurl
Dashboards List Resource
Returns a list of Analytics dashboards, or creates a dashboard.
Resource URL
/wave/dashboards
FormatsJSON
20
Dashboards List ResourceAnalytics REST API Reference
Available Version36.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0Filters the results to include only thecontents of a specific folder. Can be the
IDfolderId
requesting user’s ID for items in the user’sprivate folder.
41.0For mobile dashboards only.BoolmobileOnly
36.0A generated token that indicates the viewof dashboards to be returned.
Stringpage
36.0Number of items to be returned in a singlepage. Minimum is 1, maximum is 200, anddefault is 25.
IntpageSize
36.0Search terms. Individual terms areseparated by spaces. Wild cards aren’tsupported.
Stringq
4.1Type of scope to be applied to a collectionresource representation (CreatedByMe orSharedWithMe)
Enumscope
36.0OptionalSort order of the results. Values are:Enumsort
• LastModified
• Mru: Most recently used (last vieweddate)
• Name
The default value is Mru.
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0A collection of Analytics dashboards.DashboardRepresentation[]
dashboards
36.0Small, 36.0The URL to retrieve the next page ofcontents in the collection.
StringnextPageUrl
21
Dashboards List ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Medium, 36.0The total count of the elements in thecollection, including all pages.
IntegertotalSize
36.0Small, 36.0The URL to retrieve the collection.Stringurl
POST Request BodyDashboardInputRepresentation
POST Response BodyDashboard Representation
Example Response Body
{"dashboards": [ "/* Dashboard detail omitted for brevity. */"],"nextPageUrl": "/services/data/v36.0/wave/dashboards?page=eyJwYWdlU2lSI6UsInNv","totalSize": 33,"url": "/services/data/v36.0/wave/dashboards/0FKD00000004Cb8OAE"
}
Dashboard Resource
Returns or updates the dashboard with the specified ID or API name.
Resource URL
/wave/dashboards/<dashboard ID or API name>
FormatsJSON
Available Version36.0
HTTP MethodsGET DELETE PATCH
The POST method is supported through /wave/dashboards.
Refer to the PATCH and POST input representations below.
GET and PATCH Response Body (DashboardRepresentation)
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Indicates whether this dashboardis available for preview.
BooleanallowPreview
36.0Small, 36.0The URL for opening this asset inthe Analytics builder. This is a form
StringassetSharingUrl
of deep linking. The serverexamines the link parameters,
22
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
which might include urlType,assetId, orgId, andloginHost, as well as otheroptional parameters, andtranslates as necessary to producethe correct result on the targetclient. For example, it will open theAnalytics dashboard on desktopclients, or mobile if you are on amobile OS. For example, theshared URL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following webUrl:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
Or it might produce the followingUrl on iOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
36.0Small, 36.0The user who created thedashboard.
Wave UsercreatedBy
36.0Small, 36.0The time the dashboard wascreated.
DatecreatedDate
36.0Small, 36.0The list of datasets used to createthis dashboard.
AssetReferenceRepresentation[]datasets
36.0Small, 36.0The description of the dashboard.Stringdescription
23
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Medium, 36.0The list of files used to create thisdashboard.
Lens File[]files
36.0Small, 36.0The URL for the files associatedwith the dashboard.
StringfilesUrl
36.0Small, 36.0The folder that contains thisdashboard.
AssetReferenceRepresentation[]folder
36.0Small, 36.0The 18-character dashboard ID.Stringid
36.0Small, 36.0The label of the dashboard.Stringlabel
36.0Small, 36.0The last time the dashboard wasaccessed, in ISO8601 date format.
DatelastAccessedDate
36.0Small, 36.0The user who last updated thedashboard.
Wave UserlastModifiedBy
36.0Small, 36.0The last time the dashboard wasmodified, in ISO8601 date format.
DatelastModifiedDate
41.0Small, 41.0If the dashboard is disabled formobile.
BoolmobileDisabled
36.0Small, 36.0The name of the dashboard.Stringname
36.0Small, 36.0The namespace of the dashboard.Stringnamespace
36.0Small, 36.0The permissions for the currentuser.
Permissionspermissions
36.0Small, 36.0The date of the most recentcurrent dataset that is used by the
DaterefreshDate
dashboard, in ISO8601 dateformat.
36.0Big, 36.0The state of the dashboardDashboard Statestate
36.0Small, 36.0The asset type. For dashboards,the value is dashboard.
Stringtype
36.0Small, 36.0The URL to the resource for thedashboard.
Stringurl
Dashboard State
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
39.0Small, 39.0List of all datasource links in adashboard.
DashboardDataSourceLinkRepresentation[]dataSourceLinks
24
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
41.0Small, 41.0List of datasource filter applied inthis dashboard.
FilterItemRepresentation[]filters
36.0 (Max37.0)
Small, 36.0Styling for the grid layout. Ispaired with the gridLayoutsproperty and is meant to replacethe 'layouts' property.
GridLayoutStyleRepresentationgridLayoutStyle
36.0Small, 36.0List of all grid layouts for thisdashboard. This property replaces
GridLayoutRepresentation[]gridLayouts
the 'layouts' property and thetwo are mutually exclusive.
36.0Small, 36.0The list of layouts for thisdashboard. This list is beingreplaced by gridLayouts.
Layout[]layouts
36.0Small, 36.0The list of steps used to createthis dashboard. The key string isthe step name.
Map<String, Step>steps
37.0Small, 37.0Default styling for widgets in thisdashboard.
GridLayoutWidgetStyleRepresentationwidgetStyle
36.0Small, 36.0The list of widgets used to createthis dashboard. The key string isthe widget name.
Map<String, DashboardWidget>
widgets
DashboardDataSourceLinkRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The list of fields in a datasource linkDashboardDataSourceFieldRepresentation[]fields
39.0Small, 39.0The label of the datasource linkStringlabel
39.0Small, 39.0The name of datasource linkStringname
DashboardDataSourceFieldRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The datasource developer name.StringdataSourceName
39.0Small, 39.0The namespace that qualifies the datasetname
StringdataSourceNamespace
39.0Small, 39.0The type of datasource (Saql or Static).ConnectWaveDataSourceTypeEnumdataSourceType
25
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The name of field in the datasourceStringfieldName
FilterItemRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0Datasource on which filter will be applied.AssetReferenceRepresentation
dataset
41.0Small, 41.0List of fields in filter.String[]fields
41.0Small, 41.0Field to denote if filter is hidden in viewmode or not.
Booleanhidden
41.0Small, 41.0Label of the filter.Stringlabel
41.0Small, 41.0Field to denote if filter is locked or not.Booleanlocked
41.0Small, 41.0Operator for the filter.Stringoperator
41.0Small, 41.0Value for the filter.Stringvalue
GridLayoutStyleRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Background color for the layout.StringbackgroundColor
37.0Small, 37.0Horizontal spacing between grid cells.IntegercellSpacingX
37.0Small, 37.0Vertical spacing between grid cells.IntegercellSpacingY
39.0Small, 39.0Gutter color of the layout.StringgutterColor
39.0Small, 39.0Image representation containing thename and namespace.
AssetReferenceRepresentation
image
36.0—36.0Small, 36.0Default styling for widgets across alllayouts.
GridLayoutWidgetStyleRepresentationwidgetStyle
26
Dashboard ResourceAnalytics REST API Reference
GridLayoutWidgetStyleRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Background color for the widget. Will bea 6 character hex string. For example:#012345.
StringbackgroundColor
36.0Small, 36.0Color of the widget's border. Will be a 6character hex string. For example:#012345.
StringborderColor
36.0Small, 36.0Edges of the border to be drawn (All,Bottom, Left, Right, or Top).
ConnectWaveBorderEdgeTypeEnum[]borderEdges
36.0Small, 36.0Border radius of the widget.ObjectborderRadius
36.0Small, 36.0Width of the widget's border.ObjectborderWidth
36.0Small, 36.0Amount of padding on the bottom of thewidget when rendered on mobile clients.
IntegerbottomPadding
36.0Small, 36.0Amount of padding on the left of thewidget when rendered on mobile clients.
IntegerleftPadding
36.0Small, 36.0Amount of padding on the right of thewidget when rendered on mobile clients.
IntegerrightPadding
36.0Small, 36.0Amount of padding on the top of thewidget when rendered on mobile clients.
IntegertopPadding
GridLayoutRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0Add the ability for users to specify themaximum width that their dashboard willflex to.
IntegermaxWidth
36.0Small, 36.0Name of this layout.Stringname
38.0Small, 38.0Add the number of columns for adashboard grid layout that iscustomizable.
IntegernumColumns
36.0Small, 36.0List of pages of widgets within the layout.GridLayoutPageRepresentation[]pages
39.0Small, 39.0Specifies the grid cell row height (Fine orNormal).
ConnectWaveRowHeightEnumrowHeight
36.0Small, 36.0List of selectors this layout applies to.String[]selectors
37.0Small, 37.0Styling for the layout.GridLayoutStyleRepresentationstyle
27
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Version of this layout.Doubleversion
36.0—37.0Small, 36.0Default styling for widgets within thelayout.
GridLayoutWidgetStyleRepresentationwidgetStyle
GridLayoutPageRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Widgets within the page.GridLayoutWidgetRepresentation[]widgets
GridLayoutWidgetRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Background image for the widget.StringbackgroundImage
36.0Small, 36.0Number of grid layout columns thiswidget spans.
Integercolspan
36.0Small, 36.0Column where this widget is located.Integercolumn
36.0Small, 36.0Name of the widget.Stringname
36.0Small, 36.0Row where this widget is located.Integerrow
36.0Small, 36.0Number of grid layout rows this widgetspans.
Integerrowspan
36.0Small, 36.0Style of the widget.GridLayoutWidgetStyleRepresentationwidgetStyle
Layout
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The device rendering thisdashboard. Values are:
Stringdevice
• Applewatch
• Default
• External
• Ipad
• Iphone
28
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The layout orientation of thisdashboard. Values are:
Stringorientation
• Landscape
• Portrait
36.0Small, 36.0The list of layout pages availablefor the dashboard.
Layout Page[]pages
36.0Small, 36.0The version of the layout for thedashboard.
Doubleversion
Layout Page
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The rows associated with a layoutpage.
String[]rows
Step
Representations of different types of steps. The properties available depend on the type of step.
Valid PropertiesStep Type
columns, datasets, globalQuery, isFacet, isGlobal, label,selectMode, start, type, useGlobal, andvisualizationParameters
Multi-query step
datasets, isFacet, isGlobal, label, query, selectMode, start,type, useGlobal, and visualizationParameters
Query step
datasets, groups, isFacet, isGlobal, label, numbers, query,selectMode, start, strings, type, useGlobal, andvisualizationParameters
Saql step
groups, isFacet, label, numbers, query, selectMode, start,strings, type, useGlobal
Soql step
datasets, dimensions, groups, isFacet, isGlobal, label,selectMode, start, strings, type, useGlobal, values
Static Flex step
datasets, dimensions, isFacet, isGlobal, label, selectMode,start, type, useGlobal, values, and visualizationParameters
Static step
29
Dashboard ResourceAnalytics REST API Reference
Step Properties
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The queries to run for this step.Column[]columns
36.0Small, 36.0The list of datasets used by thisstep.
AssetReferenceRepresentation[]datasets
36.0Small, 36.0The list of dimensions for a staticstep.
String[]dimensions
36.0Small, 36.0Query override for all columns.>QueryglobalQuery
36.0Small, 36.0Indicates whether this step isfaceted to any other step.
BooleanisFacet
36.0Small, 36.0Indicates whether this step is aglobal filter that can be faceted
BooleanisGlobal
to other steps or widgets in thedashboard.
39.0Small, 39.0List of names for the projectedcolumns which the results aregrouped by for a Step.
String[]groups
39.0Small, 39.0Display label for the step.Stringlabel
39.0Small, 39.0List of projected column namesof the step.
String[]numbers
36.0Small, 36.0The query to run for this step.Queryquery
36.0Small, 36.0The select mode used to createthe step (multi, multirequired,none, single, or singlerequired).
StringselectMode
36.0Small, 36.0The start value for the step.Stringstart
39.0Small, 39.0List of projected column namesof the step.
String[]strings
36.0Small, 36.0The type of the dashboard step.Values are:
Stringtype
• Aggregate
• AggregateFlex
• Grain
• Multi
• Saql
• Soql
• Static
• StaticFlex
30
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
39.0Small, 39.0If true, the step gets tied to theglobal step.
BooleanuseGlobal
36.0Small, 36.0The list of values for a static step.String[]values
36.0Small, 36.0The parameters for the stepvisualization.
Step Visualization ParametersvisualizationParameters
Step Visualization Parameters
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The configuration options fordifferent step visualizations.
Lens Visualization Optionsoptions
40.0Small, 40.0Valid widget parameters basedon its type.
Objectparameters
40.0Small, 40.0The type of the widget. Valuesare:
ConnectWaveWidgetTypeEnumtype
• Box
• Chart
• CompareTable
• Container
• DateSelector
• GlobalFilters
• Image
• Link
• ListSelector
• Number
• PillBox
• RangeSelector
• Table
• Text
• Url
• ValuesTable
36.0Small, 36.0The type of visualization. Valuesare:
StringvisualizationType
• calheatmap: Calendarheat map
31
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
• comparisontable:Compare table
• heatmap: Heat map
• hbar: Bar
• hbarhdot: Horizontal dotplot
• matrix: Matrix
• parallelcoords:Parallel coordinates
• pie: Donut
• pivottable: Pivot table
• scatter: Scatter plot
• stackhbar: Stacked bar
• stackvbar: Stackedcolumn
• time: Timeline
• valuestable: Valuestable
• vbar: Column
• vdot: Vertical dot plot
Dashboard Widget
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The valid widget parameters(based on the type of widget).
Widget Parametersparameters
36.0Small, 36.0The position information for thewidget.
Widget Positionposition
36.0Small, 36.0The type of the widget. Valuesare:
Stringtype
• Box
• Chart
• CompareTable
• Container
• DateSelector
• GlobalFilters
• Image
32
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
• Link
• ListSelector
• Number
• PillBox
• RangeSelector
• Table
• Text
• Url
• ValuesTable
Widget Parameters
The valid parameters for a widget. The properties available depend on the type of widget.
Valid PropertiesWidget Type
backgroundColor, borderColor, imageUrl, selectModeOverride,and stretch
Box
exploreLink, maxColumnWidth, minColumnWidth,selectModeOverride, step, and totals
Compare Table
alignmentX, alignmentY, documentId, fit, image, exploreLink,maxColumnWidth, minColumnWidth, selectModeOverride, step,and totals
Container
calendarTypeSwitchingAllowed, defaultAbsoluteMode,defaultFiscalMode, expanded, instant, modeSwitchingAllowed,selectModeOverride, step, and title
Date Selector
step and selectModeOverrideGlobal Filters
alignmentX, alignmentY, documentId, fit, image, step andselectModeOverride
Image
destination, destinationLink, destinationType, fontSize,includeState, selectModeOverride, text, textAlignment,textColor, and visualizationType
Link
compact, displayTemplate, expanded, exploreLink, instant,measureField, selectModeOverride, step, and title
List Selector
compact, exploreLink, fontSize, measureField, numberColor,numberSize, selectModeOverride, step, textAlignment,textColor, title, titleColor, titleSize
Number
compact, displayTemplate, exploreLink, measureField,selectModeOverride, step, and title
Pill Box
33
Dashboard ResourceAnalytics REST API Reference
Valid PropertiesWidget Type
instant, selectModeOverride, step, and titleRange Selector
fontSize, selectModeOverride, text, textAlignment, andtextColor
Text
customBulkActions, exploreLink, fixedColumnWidth,maxColumnWidth, minColumnWidth, mode, pivoted,selectModeOverride, step, totals
Table
selectModeOverride, type, url, and videoSizeUrl
exploreLink, hideHeaderColumn, maxColumnWidth,minColumnWidth, selectModeOverride, step, and totals
Values Table
Widget Properties
The properties available depend on the type of widget.
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
37.0Small, 37.0Horizontal Alignment of theimage. Valid values: Left, Center,Right.
ConnectWaveHorizontalAlignmentEnumalignmentX
37.0Small, 37.0Vertical Alignment of the image.Valid values: Top, Center,Bottom.
ConnectWaveVerticalAlignmentEnumalignmentY
36.0Small, 36.0The background color of thewidget.
StringbackgroundColor
36.0Small, 36.0The border color of the widget.StringborderColor
39.0Small, 39.0Indicates whether widget canswitch calendar types.
BooleancalendarTypeSwitchingAllowed
36.0Small, 36.0Indicates whether the widget iscompact.
Booleancompact
39.0Small, 39.0Custom bulk actions for thiswidget.
CustomBulkActionRepresentationcustomBulkActions
39.0Small, 39.0Indicates default date mode.BooleandefaultAbsoluteMode
39.0Small, 39.0Indicates default calendar type.BooleandefaultFiscalMode
36.0Small, 36.0The destination of the link.Stringdestination
39.0Small, 39.0The destination (Dashboard,Lens, step) reference of this link.
AssetReferenceRepresentationdestinationLink
34
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The type of asset the link refersto. Values are:
StringdestinationType
• Dashboard
• Explore
• Lens
• Url
39.0Small, 39.0Display template for widgetlevel projection.
StringdisplayTemplate
37.0Small, 37.0Document Id of an image(Images uploaded usingsalesforce's document API).
StringdocumentId
36.0Small, 36.0Indicates whether the widget isexpanded.
Booleanexpanded
36.0Small, 36.0Indicates whether exploreLinkis on.
BooleanexploreLink
37.0Small, 37.0Image fit inside this widget.Valid values: Original, Tile, Cover,Strech.
ConnectWaveImageFitTypeEnumfit
40.0Small, 40.0Fixed column width for thistable widget.
IntegerfixedColumnWidth
36.0Small, 36.0The font size for the widget.IntegerfontSize
36.0Small, 36.0Indicates whether to hide thelegend.
BooleanhideHeaderColumn
39.0Small, 39.0Image representationcontaining the name andnamespace.
AssetReferenceRepresentationimage
36.0Small, 36.0A 15-character or 18-characterSalesforce document ID.
StringimageUrl
36.0Small, 36.0Indicates whether to include thestate.
BooleanincludeState
36.0Small, 36.0Indicates whether the listselector is instant.
Booleaninstant
36.0Small, 36.0Indicates whether to show thelegend.
Booleanlegend
36.0Small, 36.0Indicates whether to hide thelegend header.
BooleanlegendHideHeader
35
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The width of the legend.IntegerlegendWidth
36.0Small, 36.0The maximum width of theheader column.
IntegermaxColumnWidth
36.0Small, 36.0The measure field associatedwith this widget.
StringmeasureField
36.0Small, 36.0The minimum width of theheader column.
IntegerminColumnWidth
36.0Small, 36.0If true, the bar width is dynamicand the bar text and headerlabel are not displayed.
IntegerminiBars
40.0Small, 40.0Table mode for this widget(FitToContainer, Fixed, orVariable).
ConnectWaveTableModeEnummode
39.0Small, 39.0Indicates whether widget canswitch between two datemodes.
BooleanmodeSwitchingAllowed
36.0Small, 36.0If true, multiple measures areprojected on the same chart,
BooleanmultiMetrics
side-by-side. If false (smallmultiple), every measure is aseparate chart. The default isfalse.
36.0Small, 36.0Indicates whether to scale theposition and size of the data
Booleannormalize
shape so that it's proportionalto its percentage of its category.
36.0Small, 36.0Color of the number inside thiswidget.
StringnumberColor
36.0Small, 36.0Size of the number.ObjectnumberSize
39.0Small, 39.0Value indicating whether todisplay table as pivot.
Booleanpivoted
36.0Small, 36.0The select mode used to createthe step (multi, multirequired,none, single, singlerequired).
StringselectModeOverride
36.0Small, 36.0If true, each measure isprojected on one axis. If false, allmeasures share an axis.
BooleansplitAxis
36
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Indicates whether the horizontaland vertical axes use a squareroot scale.
Booleansqrt
36.0Small, 36.0The step name tied to thiswidget.
Stringstep
36.0Small, 36.0Indicates whether to stretch thewidget.
Booleanstretch
36.0Small, 36.0The value of the text.Stringtext
36.0Small, 36.0The alignment of the text.Values are:
StringtextAlignment
• Center
• Left
• Right
36.0Small, 36.0The text color for the widget.StringtextColor
36.0Small, 36.0The title of the widget.Stringtitle
36.0Small, 36.0Color of the title inside thiswidget.
StringtitleColor
36.0Small, 36.0Size of the title text.ObjecttitleSize
36.0Small, 36.0Indicates whether to use totals.Booleantotals
36.0Small, 36.0If true, the last group is treatedas a trellis dimension. Every
Booleantrellis
distinct value of the dimensionis a chart.
36.0Small, 36.0The type of Analytics URL for thewidget. Values are:
Stringtype
• Youtube
36.0Small, 36.0The Connect URI for the widget.Stringurl
36.0Small, 36.0Size of the video this URL pointsto.
StringvideoSize
36.0Small, 36.0The visualization type used forthis widget. Values are:
StringvisualizationType
• calheatmap: Calendarheat map
• comparisontable:Compare table
• heatmap: Heat map
37
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
• hbar: Bar
• hbarhdot: Horizontal dotplot
• matrix: Matrix
• parallelcoords:Parallel coordinates
• pie: Donut
• pivottable: Pivot table
• scatter: Scatter plot
• stackhbar: Stacked bar
• stackvbar: Stackedcolumn
• time: Timeline
• valuestable: Valuestable
• vbar: Column
• vdot: Vertical dot plot
Widget Position
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The height of the widget.Stringh
36.0Small, 36.0The width of the widget.Stringw
36.0Small, 36.0The x-index of the widget.Integerx
36.0Small, 36.0The y-index of the widget.Integery
36.0Small, 36.0The z-index of the widget.IntegerzIndex
PATCH and POST Request Body (DashboardInputRepresentation). The POST method is supported through/wave/dashboards.
DashboardInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Optional forPATCH,
The state of the dashboard.DashboardStateInputRepresentationstate
38
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
required forPOST
36.0Optional forPATCH,
Folder in which this dashboard isstored.
AssetReferenceInputRepresentationfolder
required forPOST
36.0OptionalShort description of the asset.Stringdescription
36.0Optional forPATCH,
The label of the asset.Stringlabel
required forPOST
41.0Whether the dashboard isdisabled on mobile.
BooleanmobileDisabled
36.0OptionalThe name of the asset.Stringname
DashboardStateInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0List of datasource links used aspart of this dashboard.
DashboardDataSourceLinkInputRepresentation[]dataSourceLinks
41.0List of datasource filter applied inthis dashboard.
FilterItemInputRepresentation[]filters
36.0 - 37.0OptionalOverall styling for the GridLayoutsused as part of this dashboard.
GridLayoutStyleInputRepresentationgridLayoutStyle
36.0OptionalList ofGridLayoutInputRepresentation’s
List (GridLayoutInputRepresentation[])gridLayouts
used as part of this dashboard. Ifpresent, 'layouts' must not be set.
36.0OptionalList ofLayoutInputRepresentation’sused as part of this dashboard.
List (LayoutInputRepresentation[])layouts
36.0OptionalMap of all the steps used tocreate this dashboard keyed withtheir names.
Map (key of type String) ( AggregateFlexQueryStepInputRepresentation,AggregateQueryStepInputRepresentation, GrainQueryStepInput
steps
Representation, MultiQueryStepInputRepresentation, SaqlStepInputRepresentation, SoqlStepInput
39
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
Representation) StaticFlexStepInputRepresentation, StaticStepInputRepresentation,
37.0OptionalDefault styling for widgets in thisdashboard.
GridLayoutWidgetStyleInputRepresentation
widgetStyle
36.0OptionalMap of all theDashboardWidgetInput
Map (key of type String) (DashboardWidgetInputRepresentation)
widgets
Representation’s used to createthis dashboard keyed with theirnames.
DashboardDataSourceLinkInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0List of fields connected in the datasourcelink
DashboardDataSourceFieldInputRepresentation[]fields
39.0Label of the datasource linkStringlabel
39.0Name of the datasource linkStringname
DashboardDataSourceFieldInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Developer Name of the datasource.StringdataSourceName
39.0The namespace that qualifies the datasetasset name
StringdataSourceNamespace
39.0Type of datasource (Saql or Static).ConnectWaveDataSourceTypeEnumdataSourceType
39.0Name of the field in datasourceStringfieldName
FilterItemInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
41.0Datasource on which filter will be appliedAssetReferenceInputRepresentation
dataset
40
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
41.0List of fields in filterString[]fields
41.0Field to denote if filter is hidden in viewmode or not
Booleanhidden
41.0Label of the filterStringlabel
41.0Field to denote if filter is locked or notBooleanlocked
41.0Operator for the filterStringoperator
41.0Value for the filterStringvalue
AssetReferenceInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Optional *ID of the asset.Stringid
36.0Optional *Developer name of the asset.Stringname
37.0Contextdependant
The namespace that qualifies theasset name. The default is thecurrent organization's
Stringnamespace
namespace. This is "emptynamespace" for all organizationsexcept those developer editionorgs that have set a namespace.So only set namespace whenreferencing a dataset that is froman installed managed package.
* When used in dashboard steps datasets, you must give a name. If the asset has a namespace, you must also give that. Youshould not give an id in this case, it will be ignored. In all other cases, you must give an id and neither a name or a namespace.
GridLayoutStyleInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0Background color for thelayout.
StringbackgroundColor
37.0Horizontal spacingbetween grid cells.
IntegercellSpacingX
37.0Vertical spacing betweengrid cells.
IntegercellSpacingY
41
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Gutter color of the layout.StringgutterColor
39.0Small, 39.0Image representationcontaining the name andnamespace.
AssetReferenceRepresentationimage
36.0OptionalDefault styling forwidgets across all layouts.
GridLayoutWidgetStyleInputRepresentationwidgetStyle
AggregateFlexQueryStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Optional forPATCH,
SAQL used to create this StepQueryInputRepresentationquery
required forPOST
36.0OptionalThe List of all the dataset aliasused in this step.
AssetReferenceInputRepresentation[]datasets
36.0OptionalDetermines if this step istied/facetted to any other step
BooleanisFacet
36.0OptionalIf true, this step is a global filterwhich can be faceted to othersteps/widgets in dashboard.
BooleanisGlobal
39.0Display label for the step.Stringlabel
36.0OptionalThe selectmode used (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectMode
36.0OptionalStart value for the step.Stringstart
36.0Optional forPATCH,
The type of the dashboard step(Aggregate, AggregateFlex,
ConnectWaveDashboardStepTypeEnumtype
required forPOST
Grain, Multi, Saql, Soql, Static, orStaticFlex).
36.0OptionalIf true, step gets tied to theglobal step
BooleanuseGlobal
36.0OptionalThe Visualization Parameters forthe dashboard step.
StepVisualizationParametersInputRepresentation
visualizationParameters
42
Dashboard ResourceAnalytics REST API Reference
AggregateQueryStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Optional forPATCH,
SAQL used to create this StepQueryInputRepresentationquery
required forPOST
36.0OptionalThe List of all the dataset aliasused in this step.
AssetReferenceInputRepresentation[]datasets
36.0OptionalDetermines if this step istied/facetted to any other step
BooleanisFacet
36.0OptionalIf true, this step is a global filterwhich can be faceted to othersteps/widgets in dashboard.
BooleanisGlobal
39.0Display label for the step.Stringlabel
36.0OptionalThe selectmode used (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectMode
36.0OptionalStart value for the step.Stringstart
36.0Optional forPATCH,
The type of the dashboard step(Aggregate, AggregateFlex,
ConnectWaveDashboardStepTypeEnumtype
required forPOST
Grain, Multi, Saql, Soql, Static, orStaticFlex).
36.0OptionalIf true, step gets tied to theglobal step
BooleanuseGlobal
36.0OptionalThe Visualization Parameters forthe dashboard step.
StepVisualizationParametersInputRepresentation
visualizationParameters
GrainQueryStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0Optional forPATCH,
SAQL Query to run for this step.QueryInputRepresentationquery
required forPOST
36.0OptionalA list of all the datasets used inthis step.
AssetReferenceInputRepresentation[]datasets
36.0OptionalDetermines if this step istied/facetted to any other step
BooleanisFacet
43
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0OptionalIf true, this step is a global filterwhich can be faceted to othersteps/widgets in dashboard.
BooleanisGlobal
39.0Display label for the step.Stringlabel
36.0OptionalThe selectmode used (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectMode
36.0OptionalStart value for the step.Stringstart
36.0Optional forPATCH,
The type of the dashboard step(Aggregate, AggregateFlex,
ConnectWaveDashboardStepTypeEnumtype
required forPOST
Grain, Multi, Saql, Soql, Static, orStaticFlex).
36.0OptionalIf true, step gets tied to theglobal step
BooleanuseGlobal
36.0OptionalThe Visualization Parameters forthe dashboard step.
StepVisualizationParametersInputRepresentation
visualizationParameters
MultiQueryStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0OptionalThe list of columns of thecomparison table.
ColumnInputRepresentation[]columns
36.0OptionalQuery override for all columns.QueryInputRepresentationglobalQuery
36.0OptionalThe List of all the dataset aliasused in this step.
AssetReferenceInputRepresentation[]datasets
36.0OptionalDetemines if this step istied/facetted to any other step
BooleanisFacet
36.0OptionalIf true, this step is a global filterwhich can be faceted to othersteps/widgets in dashboard.
BooleanisGlobal
39.0Display label for the step.Stringlabel
36.0OptionalThe selectmode used (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectMode
36.0OptionalStart value for the step.Stringstart
44
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0Optional forPATCH,
The type of the dashboard step(Aggregate, AggregateFlex, Grain,
ConnectWaveDashboardStepTypeEnumtype
required forPOST
Multi, Saql, Soql, Static, orStaticFlex).
36.0OptionalIf true, step gets tied to the globalstep.
BooleanuseGlobal
36.0OptionalThe Visualization Parameters forthe dashboard step.
StepVisualizationParametersInputRepresentation
visualizationParameters
SaqlStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
41.0Whether the step should broadcastfaceting.
BooleanbroadcastFacet
36.0 to 40.0Detemines if this step is tied/facetted toany other step.
BooleanisFacet
41.0Whether the step should receive faceting.BooleanreceiveFacet
SoqlStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Names for the projected columns whichthe results are grouped by for a Step
String[]groups
39.0Display label for the step.Stringlabel
39.0projected column names of the stepString[]numbers
39.0SOQL used to create this StepStringquery
39.0The selectmode used (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectMode
39.0Start value for the step.Stringstart
39.0projected column names of the stepString[]strings
36.0The type of the dashboard step(Aggregate, AggregateFlex, Grain, Multi,Saql, Soql, Static, or StaticFlex).
ConnectWaveDashboardStepTypeEnumtype
45
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0If true, step gets tied to the global stepBooleanuseGlobal
36.0The Visualization Parameters for thedashboard step.
StepVisualizationParametersInputRepresentationvisualizationParameters
StaticFlexStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalThe List of all the dataset aliasused in this step.
AssetReferenceInputRepresentation[]datasets
36.0OptionalList of dimensions of the staticstep.
String[]dimensions
39.0Names for the projected columnswhich the results are grouped byfor a Step
String[]groups
38.0OptionalDetermines if this step istied/facetted to any other step
BooleanisFacet
38.0OptionalIf true, this step is a global filterwhich can be faceted to othersteps/widgets in dashboard.
BooleanisGlobal
39.0Display label for the step.Stringlabel
39.0projected column names of thestep
String[]numbers
38.0OptionalThe selectmode used (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectMode
38.0OptionalStart value for the step.Stringstart
39.0projected column names of thestep
String[]strings
36.0Optional forPATCH,
The type of the dashboard step(Aggregate, AggregateFlex,
ConnectWaveDashboardStepTypeEnumtype
required forPOST
Grain, Multi, Saql, Soql, Static, orStaticFlex).
38.0OptionalIf true, step gets tied to the globalstep
BooleanuseGlobal
36.0OptionalList of values of this step.String[]values
46
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0OptionalThe Visualization Parameters forthe dashboard step.
StepVisualizationParametersInputRepresentation
visualizationParameters
StaticStepInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalThe List of all the dataset aliasused in this step.
AssetReferenceInputRepresentation[]datasets
36.0OptionalList of dimensions of the staticstep.
String[]dimensions
36.0OptionalDetermines if this step istied/facetted to any other step
BooleanisFacet
36.0OptionalIf true, this step is a global filterwhich can be faceted to othersteps/widgets in dashboard.
BooleanisGlobal
39.0Display label for the step.Stringlabel
36.0OptionalThe selectmode used (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectMode
36.0OptionalStart value for the step.Stringstart
36.0Optional forPATCH,
The type of the dashboard step(Aggregate, AggregateFlex,
ConnectWaveDashboardStepTypeEnumtype
required forPOST
Grain, Multi, Saql, Soql, Static, orStaticFlex).
36.0OptionalIf true, step gets tied to the globalstep
BooleanuseGlobal
36.0OptionalList of values of this step.String[]values
36.0OptionalThe Visualization Parameters forthe dashboard step.
StepVisualizationParametersInputRepresentation
visualizationParameters
ColumnInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalFormat for this column(CurrencyCents, CurrencyDollars,or Percentage).
ConnectWaveColumnFormatEnumformat
47
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalHeader text of this column.Stringheader
36.0OptionalWhether or not this column ishidden.
Booleanhidden
36.0OptionalSAQL used to create thiscomparison table.
QueryInputRepresentationquery
36.0OptionalWhether or not to show bars forthis column.
BooleanshowBars
36.0OptionalSort order for this column(Ascending, Descending,
ConnectWaveColumnSortEnumsort
InnerAscending,InnerDescending, or None).
QueryInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Optional forPATCH,
The SAQL query.Stringquery
required forPOST
36.0Optional forPATCH,
Version to which this query languageconstruct belongs.
Doubleversion
required forPOST
StepVisualizationParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalThe Visualization option associatedwith this step.
LensVisualizationOptionsInputRepresentation
options
40.0Valid Widget parameters based on itstype.
Objectparameters
40.0The type of the widget. Values are:ConnectWaveWidgetTypeEnumtype
• Box
• Chart
• CompareTable
• Container
48
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
• DateSelector
• GlobalFilters
• Image
• Link
• ListSelector
• Number
• PillBox
• RangeSelector
• Table
• Text
• Url
• ValuesTable
36.0OptionalThe type of the visualization(CalendarHeatMap, Combo,
StringvisualizationType
ComparisonTable, HeatMap,HorizontalBar, HorizontalDot, Matrix,ParallelCoordinates, Pie, PivotTable,Scatter, StackWaterfall,StackedHorizontalBar,StackedHorizontalBar, Time,ValuesTable, VerticalBar, VerticalDot,or Waterfall).
LensVisualizationOptionsInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalScale the position and size of data shape so that it’sproportional to its percentage of its category.
Booleanfit
36.0OptionalValue indicating whether to display header columnor not.
BooleanhideHeaderColumn
36.0OptionalValue indicates whether to show legend or not.Booleanlegend
36.0OptionalValue indicating whether to hide legend.BooleanlegendHideHeader
36.0OptionalThe Width of the legend.IntegerlegendWidth
36.0OptionalThe Maximum width of the header column.IntegermaxColumnWidth
36.0OptionalThe Minimum width of the header column.IntegerminColumnWidth
36.0OptionalThe width of the MiniBars, if used.IntegerminiBars
49
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalAs opposed to small multiple(default), when true,multiple measures will be projected on the same
BooleanmultiMetrics
chart, side-by-side. when small multiple, everymeasure will be its own chart.
36.0OptionalScale the position and size of data shape so that it’sproportional to its percentage of its category.
Booleannormalize
36.0OptionalWhen true, each measure is projected on one axis;otherwise, all measures share the same axis.
BooleansplitAxis
36.0OptionalValue indicating horizontal/vertical axis to be sqrtscale.
Booleansqrt
36.0OptionalValue indicating whether to display totals in the tableor not.
Booleantotals
36.0OptionalWhen true, the last group will be treated as a trellisdimension. Every distinct value of the dimension willbe a chart.
Booleantrellis
GridLayoutInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0OptionalThe maximum width that thedashboard will flex to.
IntegermaxWidth
36.0RequiredName of this layout.Stringname
38.0OptionalThe number of columns for acustomizable dashboard gridlayout.
IntegernumColumns
36.0OptionalList of pages of widgets withinthe layout.
GridLayoutPageInputRepresentation[]pages
39.0Row Height of a grid layoutcell (Fine or Normal).
ConnectWaveRowHeightEnumrowHeight
36.0OptionalList of selectors this layoutapplies to.
String[]selectors
37.0OptionalStyling for the layout.GridLayoutStyleInputRepresentationstyle
36.0RequiredVersion of this layout.Doubleversion
36.0 - 37.0OptionalDefault styling for widgetswithin the layout.
GridLayoutWidgetStyleInputRepresentation
widgetStyle
50
Dashboard ResourceAnalytics REST API Reference
GridLayoutPageInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0RequiredList of widgets within the page.GridLayoutWidgetInputRepresentation[]widgets
GridLayoutWidgetInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0OptionalBackground image for thewidget.
StringbackgroundImage
36.0RequiredNumber of grid layoutcolumns this widget spans.
Integercolspan
36.0RequiredColumn where this widgetis located.
Integercolumn
36.0RequiredName of the widget.Stringname
36.0RequiredRow where this widget islocated.
Integerrow
36.0RequiredNumber of grid layout rowsthis widget spans.
Integerrowspan
36.0RequiredStyle of the widget.GridLayoutWidgetStyleInputRepresentationwidgetStyle
GridLayoutWidgetStyleInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0RequiredBackground color for thewidget. Is a 6 character hexstring. For example: #012345.
StringbackgroundColor
36.0RequiredColor of the widget's border. Isa 6 character hex string. Forexample: #012345.
StringborderColor
36.0RequiredList of edges of the border tobe drawn (All, Bottom, Left,Right, or Top).
ConnectWaveBorderEdgeTypeEnum[]borderEdges
36.0OptionalBorder radius of the widget.IntegerborderRadius
36.0RequiredWidth of the widget's border.IntegerborderWidth
51
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalAmount of padding on thebottom of the widget whenrendered on mobile clients.
IntegerbottomPadding
36.0OptionalAmount of padding on the leftof the widget when renderedon mobile clients.
IntegerleftPadding
36.0OptionalAmount of padding on theright of the widget whenrendered on mobile clients.
IntegerrightPadding
36.0OptionalAmount of padding on the topof the widget when renderedon mobile clients.
IntegertopPadding
LayoutInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0OptionalThe device rendering thisdashboard (Applewatch,Default, External, Ipad, Iphone).
ConnectWaveLayoutDeviceTypeEnumdevice
36.0OptionalThe layout orientation of thisdashboard (Landscape orPortrait).
ConnectWaveLayoutOrientationTypeEnumorientation
36.0OptionalList of LayoutPageInputRepresentation’s available forthe dashboard.
LayoutPageInputRepresentation[]pages
36.0OptionalThe version of the layoutrepresentation for thedashboard.
Doubleversion
LayoutPageInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalGet the Rows associated with a LayoutPage.
String[]rows
52
Dashboard ResourceAnalytics REST API Reference
DashboardWidgetInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypePropertyName
36.0Optional forPATCH,
Valid widget parametersbased on its type.
Object
BoxWidgetParametersInputRepresentation,CompareTableWidgetParametersInput
parameters
required forPOSTRepresentation, ContainerWidgetParameters
InputRepresentation, DateSelectorWidgetParametersInputRepresentation, GlobalFiltersWidgetParametersInputRepresentation, ImageWidgetParametersInputRepresentation, LinkWidgetParametersInputRepresentation, ListSelectorWidgetParametersInputRepresentation,NumberWidgetParametersInputRepresentation,PillBoxWidgetParametersInputRepresentation,RangeSelectorWidgetParametersInputRepresentation, TableWidgetParametersInputRepresentation,TextWidgetParametersInputRepresentation, UrlWidgetParametersInputRepresentation, or ValuesTableWidgetParametersInputRepresentation
36.0Optional forPATCH,
Position information of thewidget on a dashboard.
WidgetPositionInputRepresentationposition
required forPOST
36.0Optional forPATCH,
The type of the widget.Values are:
ConnectWaveWidgetTypeEnumtype
required forPOST
• Box
• Chart
• CompareTable
• Container
• DateSelector
• GlobalFilters
• Image
• Link
• ListSelector
• Number
• PillBox
• RangeSelector
• Table
• Text
• Url
53
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypePropertyName
• ValuesTable
BoxWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalThe background color to be usedfor the box widget.
StringbackgroundColor
36.0OptionalThe border color to be used forthe box widget.
StringborderColor
36.0OptionalThe DocumentId of the image tobe used for the box widget.
StringimageUrl
36.0OptionalValue indicating whether tostretch the box widget or not.
Booleanstretch
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
CompareTableWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalValue indicating whether todisplay exploreLink or not.
BooleanexploreLink
36.0OptionalMaximum width of the headercolumn.
IntegermaxColumnWidth
36.0OptionalMinimum width of the headercolumn.
IntegerminColumnWidth
36.0OptionalStep name tied to this widget.Stringstep
36.0OptionalValue indicating whether thetotals column is displayed or not.
Booleantotals
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
54
Dashboard ResourceAnalytics REST API Reference
ContainerWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0Horizontal Alignment of theImage (Left, Center, Right).
ConnectWaveHorizontalAlignmentEnumalignmentX
37.0Vertical Alignment (Bottom,Center, Top).
ConnectWaveVerticalAlignmentEnumalignmentY
36.0-37.0OptionalList of widgets (by name)contained within this widget.
String[]containedWidgets
37.0Document Id of the image.StringdocumentId
37.0The image fit (FitHeight, FitWidth,Original, Stretch, Tile).
ConnectWaveImageFitTypeEnumfit
39.0Small, 39.0Image representation containingthe name and namespace.
AssetReferenceInputRepresentationimage
36.0-36.0OptionalThe URI of the image to be usedfor the container widget.
StringimageUrl
36.0-36.0OptionalValue indicating whether tostretch the container widgetbackground image.
BooleanstretchImage
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
DateSelectorWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Indicates whether widget canswitch calendar types.
BooleancalendarTypeSwitchingAllowed
39.0Indicates default date mode.BooleandefaultAbsoluteMode
39.0Indicates default calendar type.BooleandefaultFiscalMode
36.0OptionalValue indicating whether thedate selector is expanded or not.
Booleanexpanded
36.0OptionalValue indicating whether the listselector is instant or not.
Booleaninstant
39.0Indicates whether widget canswitch between two date modes.
BooleanmodeSwitchingAllowed
55
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
36.0OptionalThe step name tied to thiswidget.
Stringstep
36.0OptionalThe title of the list selectorwidget.
Stringtitle
GlobalFiltersWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalStep name tied to this widget.Stringstep
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
ImageWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0Horizontal Alignment of the Image (Left,Center, Right).
ConnectWaveHorizontalAlignmentEnumalignmentX
37.0Vertical Alignment (Bottom, Center, Top).ConnectWaveVerticalAlignmentEnumalignmentY
37.0Document Id of the imageStringdocumentId
37.0The image fit (FitHeight, FitWidth,Original, Stretch, Tile).
ConnectWaveImageFitTypeEnumfit
39.0Image representation containing thename and namespace
AssetReferenceInputRepresentationimage
LinkWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalThe destination of this link.Stringdestination
56
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
The Destination of this link,reference to Dashboard, Lensor Step.
AssetReferenceInputRepresentationdestinationLink
36.0RequiredType of the asset this linkrefers to (Dashboard, Explore,Lens, or Url).
ConnectWaveLinkWidgetDestTypeEnum
destinationType
36.0OptionalThe font size to be used forthis link widget.
IntegerfontSize
36.0OptionalWhether or not include state.BooleanincludeState
36.0OptionalValue of the text.Stringtext
39.0The Text Alignment for thiswidget (Center, Left, or Right).
ConnectWaveHorizontalAlignmentEnum
textAlignment
36.0OptionalThe color to be used for thetext of this link widget.
StringtextColor
36.0OptionalThe type of the visualization(CalendarHeatMap, Combo,
StringvisualizationType
ComparisonTable, HeatMap,HorizontalBar, HorizontalDot,Matrix, ParallelCoordinates,Pie, PivotTable, Scatter,StackWaterfall,StackedHorizontalBar,StackedHorizontalBar, Time,ValuesTable, VerticalBar,VerticalDot, or Waterfall).
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single,or SingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
ListSelectorWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalValue indicating whether the listselector is compact or not.
Booleancompact
39.0Display template for widget levelprojection.
StringdisplayTemplate
36.0OptionalValue indicating whether the listselector is expanded or not.
Booleanexpanded
57
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalValue indicating whether the listselector has ‘explore’ link or not.
BooleanexploreLink
36.0OptionalValue indicating whether the listselector is instant or not.
Booleaninstant
36.0OptionalThe measure field this widget isapplied on.
StringmeasureField
36.0OptionalThe step name tied to thiswidget.
Stringstep
36.0OptionalThe title of the list selectorwidget.
Stringtitle
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
NumberWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalWhether or not widget iscompact.
Booleancompact
36.0OptionalWhether or not widget has‘explore’ link.
BooleanexploreLink
36.0OptionalFont size of the text.ObjectfontSize
36.0OptionalThe measure field this number iscalculated upon.
StringmeasureField
36.0OptionalColor of the number inside thiswidget.
StringnumberColor
36.0OptionalSize of the number.ObjectnumberSize
36.0OptionalThe step name tied to thiswidget.
Stringstep
36.0OptionalAlignment of the text (Center,Left, or Right).
ConnectWaveHorizontalAlignmentEnum
textAlignment
36.0OptionalColor of the text inside thiswidget.
StringtextColor
36.0OptionalThe title of the widget.Stringtitle
58
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalColor of the title inside thiswidget.
StringtitleColor
36.0OptionalSize of the title text.ObjecttitleSize
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
PillBoxWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalValue indicating whether the listselector is compact or not.
Booleancompact
39.0Display template for widget levelprojection.
StringdisplayTemplate
36.0OptionalThe explore link used to createthis widget.
BooleanexploreLink
36.0OptionalMeasure field this widget isconstructed upon.
StringmeasureField
36.0OptionalThe step name tied to thiswidget.
Stringstep
36.0OptionalThe title of this widget.Stringtitle
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
RangeSelectorWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalValue indicating whether the listselector is instant or not.
Booleaninstant
36.0OptionalThe step name tied to thiswidget.
Stringstep
36.0OptionalThe title of the list selectorwidget.
Stringtitle
59
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
TableWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Custom bulk actions for this widget.CustomBulkActionInputRepresentationcustomBulkActions
38.0Value indicating whether to displayexploreLink or not.
BooleanexploreLink
40.0Fixed column width for this table widgetIntegerfixedColumnWidth
40.0Maximum column width for this tablewidget
IntegermaxColumnWidth
40.0Minimum column width for this tablewidget
IntegerminColumnWidth
36.0Select Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnum
selectModeOverride
39.0Value indicating whether to display tableas pivot or not
Booleanpivoted
38.0Step name tied to this widget.Stringstep
40.0Value indicating whether to display totalsrow or not
Booleantotals
TextWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalThe font size of the text.ObjectfontSize
36.0OptionalValue of the text inside thiswidget.
Stringtext
36.0OptionalAlignment of the text (Left,Center, or Right).
ConnectWaveHorizontalAlignmentEnum
textAlignment
36.0OptionalThe color of the text.StringtextColor
60
Dashboard ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
UrlWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalUrl widget type enum (YouTube).ConnectWaveUrlWidgetTypetype
36.0OptionalConnect URI for the widget.Stringurl
36.0OptionalSize of the video at which this urlpoints.
StringvideoSize
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
ValuesTableWidgetParametersInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalValue indicating whether theexplore link is shown or not.
BooleanexploreLink
36.0OptionalBoolean value indicating whetherto hide or show the headercolumn for this widget.
BooleanhideHeaderColumn
36.0OptionalMaximum width of the headercolumn.
IntegermaxColumnWidth
36.0OptionalMinimum width of the headercolumn.
IntegerminColumnWidth
36.0OptionalThe step name tied to thiswidget.
Stringstep
36.0OptionalValue indicating whether thetotals column is displayed or not.
Booleantotals
36.0OptionalSelect Mode Override (Multi,MultiRequired, None, Single, orSingleRequired).
ConnectWaveSelectModeEnumselectModeOverride
61
Dashboard ResourceAnalytics REST API Reference
WidgetPositionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalHeight of the widget.Stringh
36.0OptionalWidth of the widget.Stringw
36.0Optional forPATCH,
X index of widget.Integerx
required forPOST
36.0Optional forPATCH,
Y index of widget.Integery
required forPOST
36.0OptionalZ index of widget.IntegerzIndex
CustomBulkActionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Label for the custom actionStringlabel
39.0Visualforce page to invoke for the customaction
AssetReferenceInputRepresentationvisualforce
CustomBulkActionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0Label for the custom actionStringlabel
39.0Small, 39.0Visualforce page to invoke for the customaction.
AssetReferenceRepresentation
visualforce
Dashboard Image Resource
Dashboard Image Id fetcher.
Resource URL
/wave/dashboards/image/<imageFqn>
FormatsJSON
62
Dashboard Image ResourceAnalytics REST API Reference
Available Version39.0
HTTP MethodsGET
GET Response Body
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The 18-character ID of the asset.Stringid
36.0Small, 36.0The asset label.Stringlabel
36.0Small, 36.0The asset developer name.Stringname
37.0Small, 37.0The namespace that qualifies theasset name.
Stringnamespace
36.0Small, 36.0The asset URL.Stringurl
Dashboard Saved Views List Resource
Returns a list of dashboard saved views or creates a single view.
Resource URL
/wave/dashboards/<dashboard ID or API name>/savedviews
FormatsJSON
Available Version42.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
42.0The type of saved view.ConnectWaveDashboardSavedViewTypetype
• Shared
• User
63
Dashboard Saved Views List ResourceAnalytics REST API Reference
GET Response Body
DashboardSavedViewCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
42.0Small, 42.0A collection of dashboard saved views.DashboardSavedViewRepresentation[]on page 65
savedViews
POST Request Body
DashboardSavedViewInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
42.0True if this is the initial view when part ofa list of views.
BooleanisInitial
42.0Saved view Label.Stringlabel
42.0Dashboard page ID that this saved viewapplies to.
StringpageId
42.0Selections and filters to apply to thedashboard.
DashboardSavedViewStateInputRepresentationon page 64
state
42.0The type of dashboard saved view.ConnectWaveDashboardSavedViewTypetype
• Shared
• User
DashboardSavedViewStateInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
42.0Map from fully qualified dataset name todataset state.
Mapdatasets
42.0Map from step ID to step state.Mapsteps
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
42.0The type of saved view.ConnectWaveDashboardSavedViewTypeview
• Shared
• User
64
Dashboard Saved Views List ResourceAnalytics REST API Reference
POST Response Body
DashboardSavedViewRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
42.0Small, 42.0Saved view ID.Stringid
42.0Small, 42.0True if this the initial user view whenloading the dashboard.
BooleanisInitial
42.0Small, 42.0Saved view label.Stringlabel
42.0Small, 42.0ID of dashboard page that this saved viewshould switch to on the dashboard.
StringpageId
42.0Big, 42.0Selections and filters that were applieddirectly to the dashboard.
DashboardSavedViewStateRepresentationon page 65
state
42.0Small, 42.0The type of saved view.ConnectWaveDashboardSavedViewTypetype
• Shared
• User
DashboardSavedViewStateRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
42.0Small, 42.0Map from fully qualified dataset name todataset state.
Mapdatasets
42.0Small, 42.0Map from step ID to step state.Mapsteps
Dashboard Saved Views Resource
Dashboard saved view.
Resource URL
/wave/dashboards/<dashboard ID or API name>/savedviews/<View ID>
FormatsJSON
Available Version42.0
HTTP MethodsDELETE GET PATCH
GET Response BodyDashboardSavedViewRepresentation
65
Dashboard Saved Views ResourceAnalytics REST API Reference
PATCH Request BodyDashboardSavedViewInputRepresentation
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
42.0The type of saved view.ConnectWaveDashboardSavedViewTypeview
• Shared
• User
PATCH Response BodyDashboardSavedViewRepresentation
Dashboard Saved Views Initial Resource
Get the initial view information for a dashboard saved view.
Resource URL
/wave/dashboards/<dashboard ID or API name>/savedviews/initial
FormatsJSON
Available Version42.0
HTTP MethodsGET
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
42.0Saved view ID.IdviewId
GET Response Body
DashboardSavedViewInitialRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
42.0Small, 42.0The number of times the current user hasviewed the dashboard.
IntegeruserViewCount
42.0Small, 42.0The user or shared view to initially applyto dashboard.
DashboardSavedViewRepresentationview
66
Dashboard Saved Views Initial ResourceAnalytics REST API Reference
Data Connector Resource
Returns data connection properties.
Resource URL
/wave/dataConnectors/<connectorId>
FormatsJSON
Available Version39.0
HTTP MethodsDELETE GET PATCH
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The connection properties.ConnectionPropertyValueRepresentation[]
connectionProperties
39.0Small, 39.0The type of the Data Connector(AwsRdsAuroraMySQL,
ConnectWaveDataConnectorTypeEnum
connectorType
AwsRdsAuroraPostgres, AwsRdsMariaDB,AwsRdsMySQL, AwsRdsOracle,AwsRdsPostgres, AwsRdsSqlServer,AzureSqlDatabase, GoogleBigQuery,HerokuPostgres, MicrosoftDynamics,Redshift, SalesforceExternal,SalesforceLocal, SalesforceMarketingCloud,and SalesforceReport.).
PATCH Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Connection properties for the connector.DataConnectorPropertyInputRepresentation[]
connectionProperties
39.0The type of the Data Connector(AwsRdsAuroraMySQL,
ConnectWaveDataConnectorTypeEnum
connectorType
AwsRdsAuroraPostgres, AwsRdsMariaDB,AwsRdsMySQL, AwsRdsOracle,AwsRdsPostgres, AwsRdsSqlServer,AzureSqlDatabase, GoogleBigQuery,HerokuPostgres, MicrosoftDynamics,
67
Data Connector ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
Redshift, SalesforceExternal,SalesforceLocal, SalesforceMarketingCloud,and SalesforceReport.).
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0Object (DataConnectorInputRepresentation)
dataConnector
PATCH Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The connection properties.ConnectionPropertyValueRepresentation[]
connectionProperties
39.0Small, 39.0The type of the Data Connector(AwsRdsAuroraMySQL,
ConnectWaveDataConnectorTypeEnum
connectorType
AwsRdsAuroraPostgres, AwsRdsMariaDB,AwsRdsMySQL, AwsRdsOracle,AwsRdsPostgres, AwsRdsSqlServer,AzureSqlDatabase, GoogleBigQuery,HerokuPostgres, MicrosoftDynamics,Redshift, SalesforceExternal,SalesforceLocal, SalesforceMarketingCloud,and SalesforceReport.).
Data Connectors List Resource
A collection of Analytics Data Connectors.
Resource URL
/wave/dataConnectors
FormatsJSON
Available Version39.0
68
Data Connectors List ResourceAnalytics REST API Reference
HTTP MethodsGET POST
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0A list of Data Connectors.DataConnectorRepresentation[]
dataConnectors
POST Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Connection properties for the connector.DataConnectorPropertyInputRepresentation[]
connectionProperties
39.0The type of the Data Connector(AwsRdsAuroraMySQL,
ConnectWaveDataConnectorTypeEnum
connectorType
AwsRdsAuroraPostgres, AwsRdsMariaDB,AwsRdsMySQL, AwsRdsOracle,AwsRdsPostgres, AwsRdsSqlServer,AzureSqlDatabase, GoogleBigQuery,HerokuPostgres, MicrosoftDynamics,Redshift, SalesforceExternal,SalesforceLocal, SalesforceMarketingCloud,and SalesforceReport.).
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0The data connector object.ObjectdataConnector
POST Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The connection properties.ConnectionPropertyValueRepresentation[]
connectionProperties
69
Data Connectors List ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The type of the Data Connector(AwsRdsAuroraMySQL,
ConnectWaveDataConnectorTypeEnum
connectorType
AwsRdsAuroraPostgres, AwsRdsMariaDB,AwsRdsMySQL, AwsRdsOracle,AwsRdsPostgres, AwsRdsSqlServer,AzureSqlDatabase, GoogleBigQuery,HerokuPostgres, MicrosoftDynamics,Redshift, SalesforceExternal,SalesforceLocal, SalesforceMarketingCloud,and SalesforceReport.).
DataConnectorPropertyInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0The name of the connection property.Stringname
39.0The value of the connection property.Objectvalue
ConnectionPropertyValueRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The name of the connection property.Stringname
39.0Small, 39.0The value of the connection property.Objectvalue
Data Connector Source Objects List Resource
A list of all the Source Objects that the named Data Connector knows about.
Resource URL
/wave/dataConnectors/<connectorId>/sourceObjects
FormatsJSON
Available Version37.0
HTTP MethodsGET
70
Data Connector Source Objects List ResourceAnalytics REST API Reference
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0A generated token that indicates the viewof the objects to be returned.
Stringpage
37.0Number of items to be returned in a singlepage. Minimum is 1, maximum is 200, anddefault is 25.
IntpageSize
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0A list of Source Objects.SourceObjectRepresentation[]
sourceObjects
SourceObjectRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0In the event that this Source Object isinaccessible, this property contains amessagedescribing the reason.
StringaccessDeniedReason
37.0Small, 37.0If this property is present and false, theSource Object is inaccessible and cannot
Booleanaccessible
be replicated. Check theaccessDeniedReason property for moreinformation.
40.0Small, 40.0The URL to get the data preview associatedwith source object
StringdataPreviewUrl
39.0—39.0Small, 39.0The URL to get the data associated withsource object
StringdataUrl
37.0Small, 37.0The URL to get the list of Source Fields thatthis Source Object has.
StringfieldsUrl
37.0Small, 37.0The external name of this Source Object.The specifics will depend on the connectortype.
Stringname
37.0Small, 37.0Indicates if this Source Object is currentlyreplicated by Analytics or not.
Booleanreplicated
37.0Small, 37.0The URL to get this Source Object.Stringurl
71
Data Connector Source Objects List ResourceAnalytics REST API Reference
Data Connector Source Object Resource
A Source Object represents a specific category or type of data that the Data Connector knows about. When a Source Object is replicatedinto Analytics, it can be use to create Datasets.
Resource URL
/wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>
FormatsJSON
Available Version37.0
HTTP MethodsGET
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0In the event that this Source Object isinaccessible, this property contains amessagedescribing the reason.
StringaccessDeniedReason
37.0Small, 37.0If this property is present and false, theSource Object is inaccessible and cannot
Booleanaccessible
be replicated. Check theaccessDeniedReason property for moreinformation.
40.0Small, 40.0The URL to get the data preview associatedwith source object
StringdataPreviewUrl
39.0—39.0Small, 39.0The URL to get the data associated withsource object
StringdataUrl
37.0Small, 37.0The URL to get the list of Source Fields thatthis Source Object has.
StringfieldsUrl
37.0Small, 37.0The external name of this Source Object.The specifics will depend on the connectortype.
Stringname
37.0Small, 37.0Indicates if this Source Object is currentlyreplicated by Analytics or not.
Booleanreplicated
37.0Small, 37.0The URL to get this Source Object.Stringurl
72
Data Connector Source Object ResourceAnalytics REST API Reference
Data Connector Source Object Data Resource
A Source Object Data represents data that the Data Connector knows about. When a Source Object is replicated into Analytics, it canbe use to create Datasets.
Resource URL
/wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>/data
FormatsJSON
Available Version39.0
HTTP MethodsGET POST
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The json representation, as a string, fordata preview to show.
StringdataListJson
39.0Small, 39.0The URL to get this Source Object Data.Stringurl
POST Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
40.0List of fields as a way to filter the fieldsreturned in the response.
String[]sourceObjectFields
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
40.0Object (SourceObjectDataInputRepresentation)
sourceObjectFields
73
Data Connector Source Object Data ResourceAnalytics REST API Reference
POST Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The json representation, as a string, fordata preview to show.
StringdataListJson
39.0Small, 39.0The URL to get this Source Object Data.Stringurl
Data Connector Source Object Data Preview Resource
A Source Object Data represents data that the Data Connector knows about. When a Source Object is replicated into Analytics, it canbe use to create Datasets.
Resource URL
/wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>/dataPreview
FormatsJSON
Available Version40.0
HTTP MethodsGET POST
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The json representation, as a string, fordata preview to show.
StringdataListJson
39.0Small, 39.0The URL to get this Source Object Data.Stringurl
POST Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
40.0List of fields as a way to filter the fieldsreturned in the response.
String[]sourceObjectFields
74
Data Connector Source Object Data Preview ResourceAnalytics REST API Reference
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
40.0Object (SourceObjectDataInputRepresentation)
sourceObjectFields
POST Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The json representation, as a string, fordata preview to show.
StringdataListJson
39.0Small, 39.0The URL to get this Source Object Data.Stringurl
Data Connector Source Object Fields Resource
A list of Source Fields of a particular Source Object.
Resource URL
/wave/dataConnectors/<connectorId>/sourceObjects/<sourceObjectName>/fields
FormatsJSON
Available Version37.0
HTTP MethodsGET
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0A list of Source Fields.SourceFieldRepresentation[]
fields
37.0Small, 37.0URL to get the collection.Stringurl
75
Data Connector Source Object Fields ResourceAnalytics REST API Reference
SourceFieldRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0In the event that this Source Field isinaccessible, this property contains amessage describing the reason.
StringaccessDeniedReason
37.0Small, 37.0If this property is present and false, theSource Field is inaccessible and cannot be
Booleanaccessible
replicated. Check the accessDeniedReasonproperty for more information.
Data Connector Types Resource
A collection of Analytics Data Connector types.
Resource URL
/wave/dataConnectorTypes
FormatsJSON
Available Version39.0
HTTP MethodsGET
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0A list of Data Connector Types.DataConnectorTypeRepresentation[]
types
39.0Small, 39.0The URL to get the collection.Stringurl
DataConnectorTypeRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The connection properties of the dataconnector type.
ConnectionPropertyRepresentation[]
connectionProperties
39.0Small, 39.0Indicator of whether the data connectortype is external.
BooleanisExternal
39.0Small, 39.0The label of the data connector type.Stringlabel
76
Data Connector Types ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The name of the data connector type.Stringname
39.0Small, 39.0The type of the Data Connector(AwsRdsAuroraMySQL,
ConnectWaveDataConnectorTypeEnum
type
AwsRdsAuroraPostgres, AwsRdsMariaDB,AwsRdsMySQL, AwsRdsOracle,AwsRdsPostgres, AwsRdsSqlServer,AzureSqlDatabase, GoogleBigQuery,HerokuPostgres, MicrosoftDynamics,Redshift, SalesforceExternal,SalesforceLocal, SalesforceMarketingCloud,and SalesforceReport.).
ConnectionPropertyRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The field type of the connection property(Boolean, Numeric, Text).
ConnectWaveConnPropertyTypeEnum
dataType
39.0Small, 39.0The default value of the connectionproperty.
ObjectdefaultValue
39.0Small, 39.0The security setting of the connectionproperty.
BooleanisEncrypted
39.0Small, 39.0The mandatory nature of the connectionproperty.
BooleanisRequired
39.0Small, 39.0The label of the connection property.Stringlabel
39.0Small, 39.0The maximum length of the connectionproperty.
IntegermaxLength
39.0Small, 39.0The name of the connection property.Stringname
Dataflow Jobs List Resource
Returns a list of dataflow jobs.
Resource URL
/wave/dataflowjobs
FormatsJSON
77
Dataflow Jobs List ResourceAnalytics REST API Reference
Available Version42.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
42.0OptionalIf the dataflow ID is provided, the responsebody only contains dataflow jobs tied tothis specific dataflow.
StringdataflowId
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
42.0Small, 42.0A list of dataflow jobs.DataflowJobRepresentationdataflowJobs
42.0Small, 42.0The URL to get the collection.Stringurl
POST Request BodyDataflowJobInputRepresentation
POST Response BodyDataflowJobRepresentation
Dataflow Jobs Resource
A dataflow job.
Resource URL
/wave/dataflowjobs/<dataflow job ID>
FormatsJSON
Available Version42.0
HTTP MethodsGET PATCH
78
Dataflow Jobs ResourceAnalytics REST API Reference
GET Response Body
DataflowJobRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
42.0Small, 42.0The parent dataflow of a dataflow job fora user dataflow.
AssetReferenceRepresentation
dataflow
42.0Small, 42.0The runtime, in seconds, of a dataflowjob.
Integerduration
42.0Small, 42.0The error or informational message of adataflow job.
Stringmessage
42.0Small, 42.0The start date of a dataflow job.DatestartDate
42.0Small, 42.0The runtime status of a dataflow job.ConnectWaveDataflowJobStatusEnumstatus
• Failure
• Queued
• Running
• Success
• Warning
PATCH Request Body
DataflowJobInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
42.0Dataflow job command.ConnectDataflowJobCommandEnumcommand
• Start
• Stop
42.0The dataflow ID. Only required when theDataflow job command is Start.
IDdataflowId
PATCH Response BodyDataflowJobRepresentation
Dataflows List Resource
Get a list of dataflows.
Resource URL
/wave/dataflows
79
Dataflows List ResourceAnalytics REST API Reference
FormatsJSON
Available Version37.0
HTTP MethodsGET POST
GET Response Body
DataflowCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0A collection of dataflows.DataflowRepresentation[]dataflows
POST Request BodyDataflowInputRepresentation
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0A dataflow.Objectdataflow
POST Response BodyDataflowRepresentation
Dataflows Resource
Get dataflow information.
Resource URL
/wave/dataflows/<dataflowId>
FormatsJSON
Available Version37.0
HTTP MethodsGET PATCH
80
Dataflows ResourceAnalytics REST API Reference
GET Response Body
DataflowRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Current version of the dataflow.DataflowVersionRepresentationcurrent
42.0Small, 42.0Email notification level of the dataflow.The options are: Always, Failures, Never,and Warnings.
ConnectEmailNotificationLevelEnumemailNotificationLevel
42.0Small, 42.0Next scheduled run of the dataflow.DatenextScheduledDate
42.0Small, 42.0Schedule attributes of the dataflow.StringscheduleAttributes
PATCH Request Body
DataflowInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0A dataflow definition.DataflowDefinitionInputRepresentationdefinition
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0A dataflow.Objectdataflow
PATCH Response BodyDataflowRepresentation
DataflowVersionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Represents the asset creator.WaveUserRepresentationcreatedBy
37.0Small, 37.0Time the asset was created.DatecreatedDate
37.0Big, 37.0The dataflow definition.DataflowDefinitionRepresentationdefinition
37.0Small, 37.0The 18 character asset ID.Stringid
81
Dataflows ResourceAnalytics REST API Reference
Datasets List Resource
Returns a list of Analytics datasets.
You can filter the results to include only those datasets that have a current dataset version defined by using the hasCurrentOnlyparameter. You can also request supplemental information about datasets that have a current dataset version defined by using thefilterGroup parameter. For example, the following GET request sets these parameters:
/wave/datasets?hasCurrentOnly=true&filterGroup=Supplemental
This request filters the list of datasets and adds the following supplemental fields to the output representation:
• currentVersionCreatedBy
• currentVersionCreatedDate
• currentVersionLastModifiedBy
• currentVersionLastModifiedDate
For more information about the filterGroup parameter, see Specifying Response Sizes in the Chatter REST API Developer Guide.
Resource URL
/wave/datasets
FormatsJSON
Available Version36.0
HTTP MethodsGET
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0OptionalFilters the results to include only thecontents of a specific folder. Can be the
IDfolderId
requesting user’s ID for items in the user’sprivate folder.
36.0OptionalFilters the list of datasets to include onlythose datasets that have a current version.The default is false.
BooleanhasCurrentOnly
42.0OptionalOrdering applied to the results. Values are:Enumorder
• Ascending
• Descending
36.0OptionalA generated token that indicates the viewof datasets to be returned.
Stringpage
82
Datasets List ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0OptionalNumber of items to be returned in a singlepage. Minimum is 1, maximum is 200, anddefault is 25.
IntpageSize
36.0OptionalSearch terms. Individual terms areseparated by spaces. Wild cards aren’tsupported.
Stringq
41.0Type of scope to be applied to a collectionresource representation.
Enumscope
• CreatedByMe
• IncludeAllPrivate: Includeother users’ private folders
• SharedWithMe
42.0OptionalProperty names that can be sorted. Valuesare:
Enumsort
• CreatedBy
• CreatedDate
• LastModified
• LastQueried
• LastRefreshed
• Mru: Most recently used (last vieweddate)
• Name
• TotalRows
The default value is Mru.
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0List of datasets available to the currentuser.
Dataset Resource onpage 85[]
datasets
36.0Small, 36.0The URL to retrieve the next page ofcontents in the collection.
StringnextPageUrl
36.0Medium, 36.0The total count of the elements in thecollection, including all pages.
IntegertotalSize
36.0Small, 36.0The URL to retrieve the collection.Stringurl
83
Datasets List ResourceAnalytics REST API Reference
Example Response Body
{"datasets" : [ "/* Datasets detail omitted for brevity. */" ],"nextPageUrl" : "/services/data/v36.0/wave/datasets?page=eyJwYWdlU2l6ZSI6MjUsInNv","totalSize" : 33,"url" : "/services/data/v36.0/wave/datasets"
}
Dataset Resource
Returns the Analytics dataset with the specified ID, deletes a dataset (DELETE), or updates a dataset (PATCH).
Resource URL
/wave/datasets/<dataset ID>
FormatsJSON
Available Version36.0
HTTP MethodsGET, DELETE, and PATCH
PATCH Request Body
DatasetInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0—40.0OptionalThe 18-character ID of the current versionof this dataset. Do not use.
IDcurrentVersionId
36.0OptionalThe description of the dataset.Stringdescription
36.0OptionalThe 18-character ID of the folder thatcontains the dataset. For example:
"folder": {"id":"005xx000001SwTWAA0"
}
IDfolder
To patch the folder, you must have editaccess to the current and new folders.
36.0OptionalThe label of the dataset.Stringlabel
36.0OptionalThe name of the dataset.Stringname
Note: Patching of developernames for datasets is not allowed.Dataflows reference datasets byusing their developer names, and
84
Dataset ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
changing names can lead to brokendataflows.
39.0OptionalUser XMD associated with this dataset.XmdInputRepresentationuserXmd
GET and PATCH Response Body
DatasetRepresentation
AvailableVersion
FilterGroup andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of deep
StringassetSharingUrl
linking. The server examines the linkparameters, which might includeurlType, assetId, orgId, andloginHost, as well as other optionalparameters, and translates as necessary toproduce the correct result on the targetclient. For example, it will open theAnalytics dashboard on desktop clients, ormobile if you are on a mobile OS. Forexample, the shared URL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following web Url:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
Or it might produce the following Url oniOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
85
Dataset ResourceAnalytics REST API Reference
AvailableVersion
FilterGroup andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The creator of the dataset.Wave UsercreatedBy
36.0Small, 36.0The time at which the dataset was created,in ISO8601 date format.
DatecreatedDate
36.0Supplemental,36.0
The creator of the current version of thedataset. Only returned if thefilterGroup input parameter is setto Supplemental.
Wave UsercurrentVersionCreatedBy
36.0Supplemental,36.0
The time at which the current version ofthe dataset was created, in ISO8601 dateformat. Only returned if the
DatecurrentVersionCreatedDate
filterGroup input parameter is setto Supplemental.
36.0Small, 36.0The 18-character ID of the current datasetversion.
IDcurrentVersionId
36.0Supplemental,36.0
The user who last updated the currentversion of the dataset. Only returned if thefilterGroup input parameter is setto Supplemental.
Wave UsercurrentVersionLastModifiedBy
36.0Supplemental,36.0
The last time the current version of thedataset was modified, in ISO8601 dateformat. Only returned if the
DatecurrentVersionLastModifiedDate
filterGroup input parameter is setto Supplemental.
42.0Supplemental,42.0
Total number of rows in the dataset.IntegercurrentVersionTotalRows
36.0Small, 36.0The URL for the current dataset version.StringcurrentVersionUrl
40.0Small, 40.0Date/time when this dataset’s data waslast updated by a dataflow.
DatedataRefreshDate
41.0Small, 41.0The type of the dataset: Default or Trended.ConnectWaveDatasetTypeEnumdatasetType
36.0Small, 36.0Short description of the asset.Stringdescription
36.0Small, 36.0A reference to the folder in which thisdataset is stored.
AssetReferenceRepresentation
folder
36.0Small, 36.0The 18-character ID of the dataset.IDid
36.0Small, 36.0The label of the dataset.Stringlabel
39.0Small, 39.0Date/time when this dataset was lastqueried.
DatelastQueriedDate
86
Dataset ResourceAnalytics REST API Reference
AvailableVersion
FilterGroup andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The last time the dataset was accessed, inISO8601 date format.
DatelastAccessedDate
36.0Small, 36.0The user who last updated the dataset.Wave UserlastModifiedBy
36.0Small, 36.0The last time the dataset data or attributeswere modified. Includes the last time the
DatelastModifiedDate
dataset was queried. In ISO8601 dateformat.
36.0Small, 36.0The dataset name.Stringname
36.0Small, 36.0The namespace of the Asset.Stringnamespace
36.0Small, 36.0The permissions for the current user.Permissionspermissions
36.0Small, 36.0The asset type. For datasets, the value isdataset.
Stringtype
36.0Small, 36.0The URL to the resource for the dataset.Stringurl
39.0Medium,39.0
Reference to the associated user XMD (ifany).
XmdRepresentationon page 167
userXmd
36.0Small, 36.0The URL for dataset versions.StringversionsUrl
Wave User
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The 18-character user ID.IDid
36.0Small, 36.0The name of the user.Stringname
36.0Small, 36.0The Chatter profile photo of the user.StringprofilePhotoUrl
Permissions
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Indicates whether a user can manageaccess control on an asset.
Booleanmanage
36.0Small, 36.0Indicates whether a user can modify anasset.
Booleanmodify
36.0Small, 36.0Indicates whether a user can view anasset.
Booleanview
87
Dataset ResourceAnalytics REST API Reference
AssetReferenceRepresentation
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The 18-character ID of the asset.Stringid
36.0Small, 36.0The asset label.Stringlabel
36.0Small, 36.0The asset developer name.Stringname
37.0Small, 37.0The namespace that qualifies theasset name.
Stringnamespace
36.0Small, 36.0The asset URL.Stringurl
Example Response Body
{"createdBy" : {"id" : "005D00000018LSoIAM","name" : "User Name","profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
},"createdDate" : "2015-03-25T20:27:34.000Z","currentVersionId" : "0FcD00000000183KAA","currentVersionUrl" :
"/services/data/v36.0/wave/datasets/0FbD000000000huKAA/versions/0FcD00000000183KAA","folder": {"id":"005xx000001SwTWAA0"
},"id" : "0FbD000000000huKAA","label" : "OppHistory","lastAccessedDate" : "2015-03-27T18:31:39.000Z","lastModifiedBy" : {"id" : "005D00000018LT8IAM","name" : "Integration User","profilePhotoUrl" : ""https://yourInstance.salesforce.com/profilephoto/005/U""
},"lastModifiedDate" : "2015-03-25T20:27:44.000Z","name" : "OppHistory","permissions" : {"modify" : true,"view" : true
},"type" : "dataset","url" : "/services/data/v36.0/wave/datasets/0FbD000000000huKAA"
}
Dependencies Resource
Returns the dependencies for an asset.
88
Dependencies ResourceAnalytics REST API Reference
The dependencies resource returns only assets on which you have view access.
Resource URL
/wave/dependencies/<asset ID>
FormatsJSON
Available Version36.0
HTTP MethodsGET
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of deep
StringassetSharingUrl
linking. The server examines the linkparameters, which might includeurlType, assetId, orgId, andloginHost, as well as other optionalparameters, and translates as necessary toproduce the correct result on the targetclient. For example, it will open theAnalytics dashboard on desktop clients, ormobile if you are on a mobile OS. Forexample, the shared URL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following web Url:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
Or it might produce the following Url oniOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
89
Dependencies ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The dashboards that depend on the asset.DependencyCollectionRepresentation
dashboards
36.0Small, 36.0The datasets that depend on the asset.DependencyCollectionRepresentation
datasets
36.0Small, 36.0The folder containing the asset.AssetReferenceRepresentation
folder
36.0Small, 36.0The 18-character asset ID.Stringid
39.0Small, 36.0The time at which the asset was lastaccessed.
DatelastAccessedDate
36.0Small, 36.0The user who last modified the asset.Wave UserlastModifiedBy
36.0Small, 36.0The last time the asset was modified, inISO8601 date format.
DatelastModifiedDate
36.0Small, 36.0The lenses that depend on the asset.DependencyCollectionRepresentation
lenses
36.0Small, 36.0The name of the asset.Stringname
36.0Small, 36.0The asset type. Possible values are:Stringtype
• dashboard
• dataset
• folder
• lens
• workflow
36.0Small, 36.0The URL to retrieve the definition of theasset.
Stringurl
36.0Small, 36.0The dataflows that depend on the asset.DependencyCollectionRepresentation
workflows
DependencyCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The list of dependencies for an asset.Dependency[]dependencies
36.0Small, 36.0The total count of the dependencies.IntegertotalSize
90
Dependencies ResourceAnalytics REST API Reference
AssetReferenceRepresentation
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The 18-character ID of the asset.Stringid
36.0Small, 36.0The asset label.Stringlabel
36.0Small, 36.0The asset developer name.Stringname
37.0Small, 37.0The namespace that qualifies theasset name.
Stringnamespace
36.0Small, 36.0The asset URL.Stringurl
Example Response Body
{"assetSharingUrl" :
"https://yourInstance.salesforce.com/analytics/wave/application?assetId=00l40&orgId=00D40&loginHost=yourInstance.salesforce.com&urlType=sharing",
"id" : "00l40000000M5EiAAK","lastModifiedBy" : { },"lenses" : {"dependencies" : [ {"assetSharingUrl" :
"https://yourInstance.salesforce.com/analytics/wave/lens?assetId=0FK40&loginHost=yourInstance.salesforce.com&urlType=sharing",
"datasets" : {"dependencies" : [ {"id" : "0Fb400000004DKRCA2","lastModifiedBy" : { },"name" : "sales","type" : "dataset","url" : "/services/data/v36.0/wave/datasets/0Fb400000004DKRCA2"
} ],"totalSize" : 1
},"folder" : {"alias" : "Test","id" : "00l40000000M5EnAAK","label" : "Test","url" :
"https://yourInstance.salesforce.com/analytics/wave/application?assetId=00l40&loginHost=yourInstance.salesforce.com&urlType=sharing"
},"id" : "0FK400000004D8CGAU","lastModifiedBy" : {"id" : "00540000000Hf6rAAC","name" : "Admin User","profilePhotoUrl" :
"https://yourInstance.salesforce.com/profilephoto/72940000000003y/T"},
91
Dependencies ResourceAnalytics REST API Reference
"lastModifiedDate" : "2015-06-16T22:36:21.000Z","name" : "New lens","type" : "lens","url" : "/services/data/v36.0/wave/lenses/0FK400000004D8CGAU"
} ],"totalSize" : 1
},"type" : "folder"
}
Features Configuration Resource
The Analytics features that are available to a user.
Resource URL
/wave/config/features
FormatsJSON
Available Version36.0
HTTP MethodsGET
GET Response BodyGet the features available to a user.
WaveFeaturesRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Can the user create and edit Dashboards.BooleancanCreateAndEditDashboards
36.0Small, 36.0Can the user create applications.BooleancanCreateApplications
37.0Small, 37.0Can the user edit Replication setup.BooleancanEditReplication
36.0Small, 36.0Can the user upload external data.BooleancanUploadExternalData
36.0Small, 36.0Can the user access Analytics.BooleancanUseWave
38.0-39.0Small, 38.0-39.0Can the user use the XMD Editor.BooleancanUseXmdEditor
36.0Small, 36.0Is the user an Analytics Communities user.BooleanisWaveCommunitiesUser
92
Features Configuration ResourceAnalytics REST API Reference
File Resource
Provides access to the binary content of the dataset file.
Note: This resource is accessible only by the Integration User.
Resource URL
/wave/datasets/<datasetIdOrApiName>/versions/<version ID>/files/<file ID>
FormatsJSON
Available Version36.0
HTTP MethodsGET
GET Response BodyReturns the binary content of the dataset file.
Folders List Resource
Creates an Analytics application (POST), which is a folder that contains Analytics datasets, lenses, and dashboards, or returns a collectionof applications or folders (GET).
Resource URL
/wave/folders
FormatsJSON
Available Version36.0
HTTP MethodsGET and POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0BoolisPinned
36.0OptionalA generated token that indicatesthe view of the folders to bereturned.
Stringpage
36.0OptionalNumber of items to be returned ina single page. Minimum is 1,maximum is 200, and default is 25.
IntpageSize
93
File ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0OptionalSearch terms. Individual terms areseparated by spaces. Wild cardsaren’t supported.
Stringq
41.0Type of scope to be applied to acollection resource representation(CreatedByMe or SharedWithMe)
Enumscope
36.0OptionalSort order of the results. Values are:Stringsort
• LastModified
• Mru: Most recently used (lastviewed date)
• Name
The default is Mru.
36.0StringtemplateSourceId
GET Response Body
WaveFolderCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0A list of folders or applications.Wave Folder[]folders
36.0Small, 36.0The URL for the next page of content inthe collection.
StringnextPageUrl
36.0Medium, 36.0The total count of the elements in thecollection.
IntegertotalSize
36.0Small, 36.0The URL for the collection.Stringurl
POST Request Body
WaveFolderInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The creation status of application(CancelledStatus, CompletedStatus,
ConnectWaveApplicationStatusEnumapplicationStatus
DataflowInProgressStatus, FailedStatus,InProgressStatus, NewStatus).
94
Folders List ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The icon enumeration that best representsthe new folder or application. Valid valuesare 1.png through 20.png.
StringassetIcon
39.0The attached file id listAssetReferenceInputRepresentation[]attachedFiles
37.0Whether the application is shared inCommunities
BooleancanBeSharedExternally
37.0The ID of a lens/dashboard which ispresented by default for this applicationin App Runtime.
AssetReferenceInputRepresentationdefaultAsset
36.0The description of the new folder orapplication.
Stringdescription
39.0The featured assets for this application tobe used in the UI.
Map(FeaturedAssetsInputRepresentation)
featuredAssets
39.0Whether the application is a pinned folderor not
BooleanisPinned
36.0The user-facing name of the new folder orapplication.
Stringlabel
36.0The internal api name of the new folder orapplication.
Stringname
36.0The folder sharing rules.WaveFolderShareInputRepresentation[]shares
POST Response Body
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Medium, 36.0The creation status of application(CancelledStatus, CompletedStatus,
ConnectWaveApplicationStatusEnum
applicationStatus
DataflowInProgressStatus,FailedStatus, InProgressStatus,NewStatus) .
39.0Big, 39.0The id's of the files attached to theinsights folder
AssetReferenceRepresentation[]
attachedFiles
37.0Big, 37.0Whether this app can be sharedwith Community Users.
BooleancanBeSharedExternally
37.0Big, 37.0The default asset(lens/dashboard)that is presented when the app isviewed in AppRuntime mode.
AssetReferenceRepresentation
defaultAsset
95
Folders List ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
39.0Big, 39.0The featured assets for thisapplication to be used in the UI.
Map(FeaturedAssetsRepresentation)
featuredAssets
36.0Small, 36.0The asset icon.AssetReferenceRepresentation
icon
39.0Small, 39.0Whether this app ispinned/unpinned
BooleanisPinned
36.0Big, 36.0The folder shares list.WaveFolderShareRepresentation[]
shares
37.0Big, 37.0The options used on the last actionperformed on a templated Analyticsapplication.
TemplateOptionsRepresentation
templateOptions
36.0Medium, 36.0The source template ID or api nameused to create the folder orapplication.
StringtemplateSourceId
37.0Big, 37.0The template values used to createor update the folder or application(where applicable).
Map (Object)templateValues
37.0Medium, 37.0The version of the template thisapplication was created from.
StringtemplateVersion
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of
StringassetSharingUrl
deep linking. The server examinesthe link parameters, which mightinclude urlType, assetId,orgId, and loginHost, as wellas other optional parameters, andtranslates as necessary to producethe correct result on the targetclient. For example, it will open theAnalytics dashboard on desktopclients, or mobile if you are on amobile OS. For example, the sharedURL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
96
Folders List ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
Might produce the following webUrl:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
Or it might produce the followingUrl on iOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
36.0Small, 36.0The asset creator.WaveUserRepresentation
createdBy
36.0Small, 36.0Time the asset was created.DatecreatedDate
36.0Small, 36.0Short description of the asset.Stringdescription
36.0Small, 36.0The 18 character asset ID.Stringid
36.0Small, 36.0The label of the asset.Stringlabel
36.0Small, 36.0Last time the asset was accessed.DatelastAccessedDate
36.0Small, 36.0The user that last updated the asset.WaveUserRepresentation
lastModifiedBy
36.0Small, 36.0Last time the asset was modified.DatelastModifiedDate
36.0Small, 36.0The name of the asset.Stringname
36.0Small, 36.0The namespace of the asset.Stringnamespace
36.0Small, 36.0Represents permissions for thepresent user.
PermissionsRepresentation
permissions
36.0Small, 36.0The asset type. Values are:ConnectWaveAssetTypeEnum
type
• Dashboard
• DataConnector
• Dataflow
• Dataset
• DatasetShard (internal)
• DatasetVersion
97
Folders List ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
• ExternalData
• Folder
• Lens
• Recipe
• ReplicatedDataset
• Workflow
36.0Small, 36.0URL to get the definition of theasset.
Stringurl
Folder Resource
Returns the representation for an Analytics application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), ordeletes it (DELETE).
Resource URL
/wave/folders/<folder ID>
FormatsJSON
Available Version36.0
HTTP MethodsGET, PUT, PATCH, DELETE
PUT and PATCH Request Body
WaveFolderInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The creation status of application(CancelledStatus, CompletedStatus,
ConnectWaveApplicationStatusEnumapplicationStatus
DataflowInProgressStatus, FailedStatus,InProgressStatus, NewStatus).
36.0The icon enumeration that best representsthe new folder or application. Valid valuesare 1.png through 20.png.
StringassetIcon
39.0The attached file id listAssetReferenceInputRepresentation[]attachedFiles
37.0Whether the application is shared inCommunities
BooleancanBeSharedExternally
98
Folder ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0The ID of a lens/dashboard which ispresented by default for this applicationin App Runtime.
AssetReferenceInputRepresentationdefaultAsset
36.0The description of the new folder orapplication.
Stringdescription
39.0The featured assets for this application tobe used in the UI.
Map(FeaturedAssetsInputRepresentation)
featuredAssets
39.0Whether the application is a pinned folderor not
BooleanisPinned
36.0The user-facing name of the new folder orapplication.
Stringlabel
36.0The internal api name of the new folder orapplication.
Stringname
36.0The folder sharing rules.WaveFolderShareInputRepresentation[]shares
GET, PUT, and PATCH Response Body
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Medium, 36.0The creation status of application(CancelledStatus, CompletedStatus,
ConnectWaveApplicationStatusEnum
applicationStatus
DataflowInProgressStatus,FailedStatus, InProgressStatus,NewStatus) .
39.0Big, 39.0The id's of the files attached to theinsights folder
AssetReferenceRepresentation[]
attachedFiles
37.0Big, 37.0Whether this app can be sharedwith Community Users.
BooleancanBeSharedExternally
37.0Big, 37.0The default asset(lens/dashboard)that is presented when the app isviewed in AppRuntime mode.
AssetReferenceRepresentation
defaultAsset
39.0Big, 39.0The featured assets for thisapplication to be used in the UI.
Map(FeaturedAssetsRepresentation)
featuredAssets
36.0Small, 36.0The asset icon.AssetReferenceRepresentation
icon
39.0Small, 39.0Whether this app ispinned/unpinned
BooleanisPinned
99
Folder ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Big, 36.0The folder shares list.WaveFolderShareRepresentation[]
shares
37.0Big, 37.0The options used on the last actionperformed on a templated Analyticsapplication.
TemplateOptionsRepresentation
templateOptions
36.0Medium, 36.0The source template ID or api nameused to create the folder orapplication.
StringtemplateSourceId
37.0Big, 37.0The template values used to createor update the folder or application(where applicable).
Map (Object)templateValues
37.0Medium, 37.0The version of the template thisapplication was created from.
StringtemplateVersion
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of
StringassetSharingUrl
deep linking. The server examinesthe link parameters, which mightinclude urlType, assetId,orgId, and loginHost, as wellas other optional parameters, andtranslates as necessary to producethe correct result on the targetclient. For example, it will open theAnalytics dashboard on desktopclients, or mobile if you are on amobile OS. For example, the sharedURL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following webUrl:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
100
Folder ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
Or it might produce the followingUrl on iOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
36.0Small, 36.0The asset creator.WaveUserRepresentation
createdBy
36.0Small, 36.0Time the asset was created.DatecreatedDate
36.0Small, 36.0Short description of the asset.Stringdescription
36.0Small, 36.0The 18 character asset ID.Stringid
36.0Small, 36.0The label of the asset.Stringlabel
36.0Small, 36.0Last time the asset was accessed.DatelastAccessedDate
36.0Small, 36.0The user that last updated the asset.WaveUserRepresentation
lastModifiedBy
36.0Small, 36.0Last time the asset was modified.DatelastModifiedDate
36.0Small, 36.0The name of the asset.Stringname
36.0Small, 36.0The namespace of the asset.Stringnamespace
36.0Small, 36.0Represents permissions for thepresent user.
PermissionsRepresentation
permissions
36.0Small, 36.0The asset type. Values are:ConnectWaveAssetTypeEnum
type
• Dashboard
• DataConnector
• Dataflow
• Dataset
• DatasetShard (internal)
• DatasetVersion
• ExternalData
• Folder
• Lens
• Recipe
• ReplicatedDataset
• Workflow
101
Folder ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0URL to get the definition of theasset.
Stringurl
FeaturedAssetsRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The list of featured assets.TypedAssetReferenceRepresentation[]assets
TypedAssetReferenceRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
40.0Small, 40.0The asset type (Dashboard,DataConnector, DataPoolEntity,
ConnectWaveAssetTypeEnumtype
DataPoolEntityVersion, Dataflow,DataflowJob, Dataset, DatasetShard,DatasetVersion, ExternalData, Folder,Lens, Recipe, ReplicatedDataset, orWorkflow).
WaveFolderShareInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The access type (Edit, Manage, View).ConnectWaveAccessTypeEnumaccessType
36.0The share type (AllCspUsers, AllPrmUsers,CustomerPortalUser, Group, Organization,
ConnectWaveShareTypeEnumshareType
PartnerUser, PortalRole,PortalRoleAndSubordinates, Role,RoleAndSubordinates, User).
36.0ID of the entity that the folder is sharedwith.
IDsharedWithId
Wave Folder Share
WaveFolderShareRepresentation
102
Folder ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The access type of the user (Edit,Manage, or View).
ConnectWaveAccessTypeEnum
accessType
36.0Small, 36.0The url of the user image.StringimageUrl
36.0Small, 36.0The share type of the user.ConnectWaveShareTypeEnum
shareType
• AllCspUsers
• AllPrmUsers
• CustomerPortalUser
• Group
• Organization
• PartnerUser
• PortalRole
• PortalRoleAndSubordinates
• Role
• RoleAndSubordinates
• User
36.0Small, 36.0The Id of the user with the sharerepresentation.
StringsharedWithId
36.0Small, 36.0The label for the shareuser/group/org.
StringsharedWithLabel
FeaturedAssetsInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0list of default featured assetsTypedAssetReferenceInputRepresentation[]assets
TypedAssetReferenceInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
40.0The asset type (Dashboard,DataConnector, DataPoolEntity,
ConnectWaveAssetTypeEnumtype
DataPoolEntityVersion, Dataflow,DataflowJob, Dataset, DatasetShard,DatasetVersion, ExternalData, Folder,Lens, Recipe, ReplicatedDataset, orWorkflow).
103
Folder ResourceAnalytics REST API Reference
Template Options
TemplateOptionsRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Medium, 37.0The last template action performed onthe templated application (Create orUpgrade).
ConnectWaveTemplateAppActionEnum
appAction
37.0Medium, 37.0The date/time the last action wasperformed.
DateappActionDate
37.0Medium, 37.0The user that performed the last action.WaveUserRepresentation
appActionUser
Example Response Body
{"applicationStatus" : "newstatus","assetIcon" : "6.png","assetIconUrl" : "https://yourInstance.salesforce.com/icons/6.png","assetSharingUrl" :
"https://yourInstance.salesforce.com/application?assetId=xxx&orgId=yyy&loginHost=jsmith-ltm.yourInstance.salesforce.com&urlType=sharing",
"createdBy" : {"id" : "005xx000001SxwEAAS","name" : "Admin User","profilePhotoUrl" : "/profilephoto/005/T"
},"createdDate" : "2015-06-22T17:38:33.000Z","description" : "descr","icon" : {"alias" : "6.png","id" : "02Ixx00000003qvEAA","url" : "/app/icons/6.png"
},"id" : "02Ixx00000003qvEAA","label" : "A new App","lastModifiedBy" : {"id" : "005xx000001SxwEAAS","name" : "Admin User","profilePhotoUrl" : "/profilephoto/005/T"
},"lastModifiedDate" : "2015-06-22T17:38:33.000Z","name" : "A_new_App1","permissions" : {"manage" : true,"modify" : true,"view" : true
},"shares" : [ {
104
Folder ResourceAnalytics REST API Reference
"accessType" : "manage","imageUrl" : "/profilephoto/00G/T","shareType" : "organization","sharedWithId" : "00Gxx000000nCDzEAM","sharedWithLabel" : "All Internal Users"
}, {"accessType" : "manage","imageUrl" : "/profilephoto/005/T","shareType" : "user","sharedWithId" : "005xx000001SxzaAAC","sharedWithLabel" : "Integration User"
} ],"type" : "folder","url" : "/services/data/v36.0/wave/folders/00lxx000000fmEpAAI"
}
Lenses List Resource
Returns a list of Analytics lenses (GET), or creates a lens (POST).
Resource URL
/wave/lenses
FormatsJSON
Available Version36.0
HTTP MethodsGET and POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0OptionalFilters the results to include onlythe contents of a specific folder. Can
IDfolderId
be the requesting user’s ID for itemsin the user’s private folder.
36.0OptionalA generated token that indicatesthe view of the lenses to bereturned.
Stringpage
36.0OptionalNumber of items to be returned ina single page. Minimum is 1,maximum is 200, and default is 25.
IntpageSize
105
Lenses List ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0OptionalSearch terms. Individual terms areseparated by spaces. Wild cardsaren’t supported.
For example, if you have lenses withthe following names:
Stringq
• Opportunities_Created_2010
• Opportunities_Created_2011
Setting q = “Opportunities 2010”returns onlyOpportunities_Created_2010.
41.0Type of scope to be applied to acollection resource representation
Enumscope
(CreatedByMe, IncludeAllPrivate, orSharedWithMe)
36.0OptionalSort order of the results. Values are:Stringsort
• LastModified
• Mru: Most recently used (lastviewed date)
• Name
The default is Mru.
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0List of lenses available to the current user.Lens[]lenses
36.0Small, 36.0The URL to retrieve the next page ofcontents in the collection.
StringnextPageUrl
36.0Medium, 36.0The total count of the elements in thecollection, including all pages.
IntegertotalSize
36.0Small, 36.0The URL to retrieve the collection.Stringurl
Example Response Body
{"lenses" : [ "/* Lenses detail omitted for brevity. */" ],"nextPageUrl" : "/services/data/v36.0/wave/lenses?page=eyJwYWdlU2l6ZSI6MjUsInNv","totalSize" : 14,
106
Lenses List ResourceAnalytics REST API Reference
"url" : "/services/data/v36.0/wave/lenses"}
Request Body (for POST and /wave/lenses/<lens ID> PATCH)
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Required for POST,optional for PATCH
The dataset to be used to create this lens.AssetReferenceInputRepresentationon page 107
dataset
36.0Required for POST,optional for PATCH
Folder in which this lens is stored.AssetReferenceInputRepresentationon page 107
folder
36.0Required for POST,optional for PATCH
The state of the lens.State Inputstate
36.0Required for POST,optional for PATCH
The visualization type to be used for thislens. Values are:
StringvisualizationType
• calheatmap: Calendar heat map
• comparisontable: Comparetable
• heatmap: Heat map
• hbar: Bar
• hbarhdot: Horizontal dot plot
• matrix: Matrix
• parallelcoords: Parallelcoordinates
• pie: Donut
• pivottable: Pivot table
• scatter: Scatter plot
• stackhbar: Stacked bar
• stackvbar: Stacked column
• time: Timeline
• valuestable: Values table
• vbar: Column
• vdot: Vertical dot plot
AssetReferenceInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0ID of the assetStringid
107
Lenses List ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Developer name of the assetStringname
State Input
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Must be specifiedfor comparisontables only.
A list of the columns for a comparisontable lens.
Column[]columns
36.0OptionalThe configuration options for differentlens visualizations.
Lens VisualizationOptions Input
options
36.0If using anyvisualization type
The SAQL query to be used to create thislens.
QueryInputRepresentation onpage 108
query
other thancomparison table,you are required tospecify thisproperty.
QueryInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The SAQL query.Stringquery
36.0The version of the SAQL query.Doubleversion
Lens Visualization Options Input
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalIndicates whether to scale the positionand size of data shape so that it is
Booleanfit
proportional to the percentage of itscategory.
36.0OptionalIndicates whether to display a headercolumn.
BooleanhideHeaderColumn
36.0OptionalIndicates whether to show a legend.Booleanlegend
108
Lenses List ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0OptionalIndicates whether to hide the legendheader.
BooleanlegendHideHeader
36.0OptionalThe width of the legendIntegerlegendWidth
36.0OptionalThe maximum width of the headercolumn.
IntegermaxColumnWidth
36.0OptionalThe minimum width of the headercolumn.
IntegerminColumnWidth
36.0OptionalThe width of the mini-bars, if used.IntegerminiBars
36.0OptionalWhen true, indicates that multiplemeasures are displayed on the same
BooleanmultiMetrics
chart, side-by-side. When false, eachmeasure is displayed on a separate chart.The default is false.
36.0OptionalScale the position and size of the datashape so that it’s proportional to thepercentage of its category.
Booleannormalize
36.0OptionalWhen true, each measure is projectedonto one axis. When false, allmeasures use the same axis.
BooleansplitAxis
36.0OptionalIndicates that the horizontal and verticalaxes use a square root scale.
Booleansqrt
36.0OptionalIndicates whether to display totals in thetable.
Booleantotals
36.0OptionalWhen true, the last group is treated asa trellis dimension. Every distinct value ofthe dimension is a chart.
Booleantrellis
POST Response BodyLens
Lens Resource
Returns a JSON file that describes the structure of an Analytics lens with the specified ID (GET), deletes a lens (DELETE), or updates a lens(PATCH).
Resource URL
/wave/lenses/<lens Id or Api Name>
109
Lens ResourceAnalytics REST API Reference
FormatsJSON
Available Version36.0
HTTP MethodsGET, DELETE, and PATCH
PATCH Request BodyRequest Body (for POST and /wave/lenses/<lens ID> PATCH)
When updating a lens, you can specify a single property by itself, or any combination of properties.
Note: The state and visualizationType properties must be patched together if the type is being changed to (orfrom) comparison table.
GET and PATCH Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Indicates whether the user is allowed topreview the lens.
BooleanallowPreview
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of deep
StringassetSharingUrl
linking. The server examines the linkparameters, which might includeurlType, assetId, orgId, andloginHost, as well as other optionalparameters, and translates as necessary toproduce the correct result on the targetclient. For example, it will open theAnalytics dashboard on desktop clients, ormobile if you are on a mobile OS. Forexample, the shared URL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following web Url:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
110
Lens ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
Or it might produce the following Url oniOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
36.0Small, 36.0The creator of the lens.Wave UsercreatedBy
36.0Small, 36.0The time at which the lens was created, inISO8601 date format.
DatecreatedDate
36.0Small, 36.0A reference to the dataset used to createthis lens.
Dataset Referencedataset
36.0Medium, 36.0Information about the icon used torepresent the lens in the user interface.
Lens File[]files
36.0Small, 36.0Url to lens files.StringfilesUrl
36.0Small, 36.0A reference to the folder in which this lensis stored.
AssetReferenceRepresentation
folder
36.0Small, 36.0The 18-character lens ID.IDid
36.0Small, 36.0The label of the lens.Stringlabel
36.0Small, 36.0The last time the lens was accessed, inISO8601 date format.
DatelastAccessedDate
36.0Small, 36.0The user who last updated the lens.Wave UserlastModifiedBy
36.0Small, 36.0The last time the lens was modified, inISO8601 date format.
DatelastModifiedDate
36.0Small, 36.0The name of the lens.Stringname
36.0Small, 36.0The permissions for the current user.Permissionspermissions
36.0Small, 36.0The date of the most recent currentdataset that is used by the lens, in ISO8601date format.
DaterefreshDate
36.0Big, 36.0The state of the lens.Lens Statestate
36.0Small, 36.0The asset type. For lenses, the value islens.
Stringtype
36.0Small, 36.0The URL to the resource for the lens.Stringurl
111
Lens ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The visualization type used for this lens.Values are:
StringvisualizationType
• calheatmap: Calendar heat map
• comparisontable: Comparetable
• heatmap: Heat map
• hbar: Bar
• hbarhdot: Horizontal dot plot
• matrix: Matrix
• parallelcoords: Parallelcoordinates
• pie: Donut
• pivottable: Pivot table
• scatter: Scatter plot
• stackhbar: Stacked bar
• stackvbar: Stacked column
• time: Timeline
• valuestable: Values table
• vbar: Column
• vdot: Vertical dot plot
Lens File
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The content type of the file.StringcontentType
36.0Small, 36.0The length of the file in KB.IntegerfileLength
36.0Small, 36.0The name of the file.StringfileName
36.0Small, 36.0The 18-character lens file ID.IDid
36.0Small, 36.0The last modified date of the file, inISO8601 date format.
DatelastModifiedDate
112
Lens ResourceAnalytics REST API Reference
Lens State
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0A list of the columns for a comparisontable lens. Only returned if thevisualization type is a comparison table.
Column[]columns
36.0Small, 36.0The configuration options for differentlens visualizations.
Lens VisualizationOptions
options
36.0Small, 36.0The query used to create this lens.Returned for all visualization types exceptfor comparison tables.
Queryquery
Column
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The header text for this column.Stringheader
36.0Small, 36.0Indicates whether this column is hidden.Booleanhidden
36.0Small, 36.0The query used to create this column.Queryquery
36.0Small, 36.0Indicates whether to show bars for thiscolumn.
BooleanshowBars
36.0Small, 36.0The sort order for this column. Values are:Stringsort
• Ascending: Sort in ascendingorder
• Descending: Sort in descendingorder
• InnerAscending: Sort withingroups in ascending order
• InnerDescending: Sort withingroups in descending order
• None: No sort order
Lens Visualization Options
The valid configuration options for a visualization. The properties available depend on the type of visualization.
Valid PropertiesVisualization Type
legend, legendHideHeader, legendWidth,maxColumnWidth, minColumnWidth,
Bar
113
Lens ResourceAnalytics REST API Reference
Valid PropertiesVisualization Type
miniBars, multiMetrics, splitAxis, sqrt,and trellis
maxColumnWidth and minColumnWidthCompare Table
legend, legendHideHeader, andlegendWidth
Donut
fit, legend, legendHideHeader,legendWidth, and sqrt
Dot Plot
legend, legendHideHeader, andlegendWidth
Heat Map
legend, legendHideHeader, andlegendWidth
Matrix
fit, legend, legendHideHeader,legendWidth, and sqrt
Parallel Coordinates
maxColumnWidth, minColumnWidth, andtotals
Pivot Table
fit, legend, legendHideHeader,legendWidth, and sqrt
Scatter Plot
legend, legendHideHeader, legendWidth,maxColumnWidth, minColumnWidth,miniBars, normalize, and sqrt
Stacked Bar/Column
fit, legend, legendHideHeader,legendWidth, and sqrt
Timeline
hideHeaderColumn, maxColumnWidth, andminColumnWidth
Values Table
Visualization Properties
The properties available depend on the type of visualization.
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Indicates whether to scale theposition and size of a data shape so
Booleanfit
that it's proportional to its percentageof its category.
36.0Small, 36.0Indicates whether to display theheader column.
BooleanhideHeaderColumn
36.0Small, 36.0Indicates whether to display thelegend.
Booleanlegend
114
Lens ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Indicates whether to hide the legendheader.
BooleanlegendHideHeader
36.0Small, 36.0The width of the legendIntegerlegendWidth
36.0Small, 36.0The maximum width of the headercolumn.
IntegermaxColumnWidth
36.0Small, 36.0The minimum width of the headercolumn.
IntegerminColumnWidth
36.0Small, 36.0The width of the mini-bars, if used.IntegerminiBars
36.0Small, 36.0When true, indicates that multiplemeasures are displayed on the same
BooleanmultiMetrics
chart, side-by-side. When false, eachmeasure is displayed on a separatechart. The default value is false.
36.0Small, 36.0Scale the position and size of the datashape so that it's proportional to itspercentage of its category.
Booleannormalize
36.0Small, 36.0When true, each measure is projectedonto one axis. When false, allmeasures use the same axis.
BooleansplitAxis
36.0Small, 36.0Indicates that the horizontal verticalaxes use a square root scale.
Booleansqrt
36.0Small, 36.0When true, the last group is treatedas a trellis dimension. Every distinctvalue of the dimension is a chart.
Booleantrellis
36.0Small, 36.0Indicates whether to display totals inthe table.
Booleantotals
Query
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The query text. This will typically be inshort form (as seen in the UI), or may be
Stringquery
in SAQL form if the query was edited inthe UI and saved as SAQL.
36.0Small, 36.0The version of this query.Doubleversion
115
Lens ResourceAnalytics REST API Reference
Example Response Body
{"allowPreview" : true,"assetSharingUrl" : "https://yourInstance.salesforce.com/
analytics/wave/lens?assetId=0FKD00000004CVjOAM&orgId=00DD00000007dBq&loginHost=yourInstance.salesforce.com&urlType=sharing",
"createdBy" : {"id" : "005D00000018LSoIAM","name" : "User Name","profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
},"createdDate" : "2015-02-06T17:40:28.000Z","dataset" : {"id" : "0FbD000000000ExKAI","url" : "/services/data/v36.0/wave/datasets/0FbD000000000ExKAI"
},"files" : [ {"contentType" : "image/png","fileLength" : 3105,"fileName" : "assetPreviewThumb","id" : "0FJD00000004CEiOAM","lastModifiedDate" : "2015-02-06T17:40:29.000Z"
} ],"folderId" : "00lD0000000w3y6IAA","id" : "0FKD00000004CVjOAM","label" : "UsersWithRoles Lens","lastAccessedDate" : "2015-04-02T23:02:12.000Z","lastModifiedBy" : {"id" : "005D00000018LSoIAM","name" : "User Name","profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
},"lastModifiedDate" : "2015-02-06T17:40:28.000Z","name" : "UsersWithRoles_Lens","permissions" : {"modify" : true,"view" : true
},"refreshDate" : "2015-02-20T17:42:50.000Z","state" : {"options" : {"sqrt" : true
},"query" : {"query" :
"{"values":["Name","CommunityNickname","Alias"]}",
"version" : -1.0}
},"type" : "lens","url" : "/services/data/v36.0/wave/lenses/0FKD00000004CVjOAM",
116
Lens ResourceAnalytics REST API Reference
"visualizationType" : "valuestable"}
Lens File Resource
Returns a file that is part of an Analytics lens.
Resource URL
/wave/lenses/<lens Id or Api Name>/files/<file Id>
FormatsJSON
Available Version36.0
HTTP MethodsGET, PUT
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameter Name
36.0IdfileId
36.0IdlensId
GET Response BodyReturns the binary stream of the contents of the specified file.
PUT Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0BinarypreviewFile
PUT Response BodyUpdates the contents of the specified file.
WaveFileMetadataRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Medium, 36.0created by userWaveUserRepresentation
createdBy
36.0Medium, 36.0created dateDatecreatedDate
36.0Small, 36.0The 18 character lens file ID.Stringid
117
Lens File ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Medium, 36.0last accessed dateDatelastAccessedDate
36.0Medium, 36.0last modified dateDatelastModifiedDate
36.0Small, 36.0size of the lens fileIntegerlength
36.0Small, 36.0name of lens fileStringname
36.0Small, 36.0url of file.Stringurl
WaveUserRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The 18 character user ID.Stringid
36.0Small, 36.0The name of the user.Stringname
36.0Small, 36.0The Chatter profile photo of the user.StringprofilePhotoUrl
Lens File Metadata Resource
Resource for management of Analytics lens file metadata.
Resource URL
/wave/lenses/<lens Id or Api Name>/files
FormatsJSON
Available Version36.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0Stringpage
36.0IntpageSize
118
Lens File Metadata ResourceAnalytics REST API Reference
GET Response BodyGet a collection of Analytics lens file metadata.
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0List of file metadata.WaveFileMetadataRepresentation[]
files
36.0Small, 36.0URL to get the next page of contents inthe collection.
StringnextPageUrl
36.0Medium, 36.0Gets the total count of the elements in thecollection irrespective of the page.
IntegertotalSize
36.0Small, 36.0URL to get the collection.Stringurl
WaveFileMetadataRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Medium, 36.0created by userWaveUserRepresentation
createdBy
36.0Medium, 36.0created dateDatecreatedDate
36.0Small, 36.0The 18 character lens file ID.Stringid
36.0Medium, 36.0last accessed dateDatelastAccessedDate
36.0Medium, 36.0last modified dateDatelastModifiedDate
36.0Small, 36.0size of the lens fileIntegerlength
36.0Small, 36.0name of lens fileStringname
36.0Small, 36.0url of file.Stringurl
WaveUserRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The 18 character user ID.Stringid
36.0Small, 36.0The name of the user.Stringname
36.0Small, 36.0The Chatter profile photo of the user.StringprofilePhotoUrl
119
Lens File Metadata ResourceAnalytics REST API Reference
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0BinarypreviewFile
POST Response BodyCreates lens file.
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Medium, 36.0created by userWaveUserRepresentation
createdBy
36.0Medium, 36.0created dateDatecreatedDate
36.0Small, 36.0The 18 character lens file ID.Stringid
36.0Medium, 36.0last accessed dateDatelastAccessedDate
36.0Medium, 36.0last modified dateDatelastModifiedDate
36.0Small, 36.0size of the lens fileIntegerlength
36.0Small, 36.0name of lens fileStringname
36.0Small, 36.0url of file.Stringurl
Query Resource
Executes a query written in Salesforce Analytics Query Language (SAQL).
Resource URL
/wave/query
FormatsJSON
Available Version36.0
HTTP MethodsPOST
120
Query ResourceAnalytics REST API Reference
POST Request Body
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0RequiredThe query, in JSON format.Object (SaqlQueryInputRepresentation)
query
Example Request Body
{"query":"q = load \"0Fbxx0000000006CAA/0Fcxx000000001dCAA\";q = group q by 'FirstName';q = foreach q generate 'FirstName' as 'FirstName', count() as 'count';q = limit q 2000;"
}
POST Response Body
Available VersionFilter Group and VersionDescription
36.0Small, 36.0The results of a SAQL query, in JSON format. This may also containmetadata describing grouping and column types/names. Referto the example response bodies and the section discussing querymetadata.
SaqlQueryInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
41.0RequiredThe query name.Stringname
36.0RequiredThe query.Stringquery
Example Response Body (without metadata)
{"action":"query","responseId":"3vy-E9YmX-TIWe0769juD-","results": {"records":[{"FirstName":"","count":1},{"FirstName":"Admin","count":1},{"FirstName":"Integration","count":1},{"FirstName":"Security","count":1}
]},"query":"q = load \"0Fbxx0000000006CAA/0Fcxx000000001dCAA\";
q = group q by 'FirstName';
121
Query ResourceAnalytics REST API Reference
q = foreach q generate 'FirstName' as 'FirstName', count() as 'count';q = limit q 2000;",
"responseTime":544}
Example Response Body (with metadata)
{"action":"query","responseId":"3vy-E9YmX-TIWe0769juD-","results": {"metadata": {"columns":[{"name":"FirstName", "type":"String"},{"name":"count", "type":"Numeric"}
],"groups":["FirstName"]
},"records":[{"FirstName":"","count":1},{"FirstName":"Admin","count":1},{"FirstName":"Integration","count":1},{"FirstName":"Security","count":1}
]},"query":"q = load \"0Fbxx0000000006CAA/0Fcxx000000001dCAA\";
q = group q by 'FirstName';q = foreach q generate 'FirstName' as 'FirstName', count() as 'count';q = limit q 2000;",
"responseTime":544}
Query metadata
Clients can parse the SAQL queries to figure out what dimensions and groups are used, but this can be expensive. So, in most cases,the query response will contain a metadata section, which provides grouping and column information. The metadata section, ifpresent, will be found in the results key in the query response payload. The metadata section is structured with columns and groupskeys:
"metadata":{"columns":[{"name":"dim name", "type":"String"}],"groups":["name","destination"]
}
The columns key includes the name and type of the projections of the query, and the groups key contains a list of groups used inthe query.
Note:
• The metadata will be added when the query is successful. If the query fails to run, if there is a syntax error, or if theauthorization callback fails then the metadata will not be added to the results.
• The value set in a column name is the alias given to the projection and not the name of the dimension.
• A list of the groups used in the query will be returned in the groups key, provided the query is not consideredcomplex—where the group name returned is nondeterministic (the name of the group is used in multiple streams of thequery). This is the case when the query uses cogroup or union. In such cases, the groups key will be empty.
122
Query ResourceAnalytics REST API Reference
For more information about creating SAQL queries, see Analytics SAQL Referenceand the Analytics SDK Guide.
Recipes List Resource
A listing of Data Prep recipes.
Resource URL
/wave/recipes
FormatsJSON
Available Version38.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
38.0A generated token that indicates the viewof the objects to be returned.
Stringpage
38.0Number of items to be returned in a singlepage. Minimum is 1, maximum is 200, anddefault is 25.
IntpageSize
38.0Search terms. Individual terms areseparated by spaces. Wild cards aren’tsupported.
Stringq
38.0LastModified, Mru, or Name.ConnectWaveSortOrderTypeEnumsort
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0A list of recipes.RecipeRepresentationon page 124[]
recipes
POST Request BodyRecipeInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0The recipe's dataflow definition.StringdataflowDefinition
123
Recipes List ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
41.0The recipe's execution engine. V1(dataflow definition) or V2 (directly onSpark).
EnumexecutionEngine
38.0The recipe's file content. This property isinternal to the recipe UI and is available fordebugging and reference purposes only.
StringfileContent
38.0The recipe's publish folder.AssetReferenceInputRepresentationon page 41
folder
38.0A short label for the recipe.Stringlabel
38.0The name of the recipe.Stringname
42.0Small, 42.0The target format or system to publish therecipe to: Dataset, IoT, or DataPool stagingarea.
ConnectRecipePublishingTargetEnumpublishingTarget
38.0The recipe's target dataset's securitypredicate.
StringrowLevelSecurityPredicate
38.0The recipe's schedule dataflow run.Stringschedule
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
38.0Recipe JSON file (transforms). ForSalesforce use only.
BinaryrecipeFile
38.0Metadata information such as recipe name,dataflow definition (if any), label, folder,and so on.
Object(RecipeInputRepresentation)
recipeObject
POST Response BodyRecipeRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0Last dataflow update.DatedataflowLastUpdate
38.0Small, 38.0Target DatasetAssetReferenceRepresentation onpage 88
dataset
38.0Small, 38.0URL to get the recipe's file content.StringfileUrl
124
Recipes List ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
42.0Small, 42.0The target format or system to publish therecipe to: Dataset, IoT, or DataPool stagingarea.
ConnectRecipePublishingTargetEnumpublishingTarget
38.0Small, 38.0The security predicate of the target datasetStringrowLevelSecurityPredicate
38.0Small, 38.0The schedule cron expression currentdataflow.
Stringschedule
42.0Small, 42.0Target Dataflow ID.StringtargetDataflowId
Recipe Resource
A Data Prep recipe.
Resource URL
/wave/recipes/<id>
FormatsJSON
Available Version38.0
HTTP MethodsDELETE GET PATCH
GET Response BodyRecipeRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0Last dataflow update.DatedataflowLastUpdate
38.0Small, 38.0Target DatasetAssetReferenceRepresentation onpage 88
dataset
38.0Small, 38.0URL to get the recipe's file content.StringfileUrl
42.0Small, 42.0The target format or system to publish therecipe to: Dataset, IoT, or DataPool stagingarea.
ConnectRecipePublishingTargetEnumpublishingTarget
38.0Small, 38.0The security predicate of the target datasetStringrowLevelSecurityPredicate
38.0Small, 38.0The schedule cron expression currentdataflow.
Stringschedule
42.0Small, 42.0Target Dataflow ID.StringtargetDataflowId
125
Recipe ResourceAnalytics REST API Reference
PATCH Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0The recipe's dataflow definition.StringdataflowDefinition
41.0The recipe's execution engine. V1(dataflow definition) or V2 (directly onSpark).
EnumexecutionEngine
38.0The recipe's file content. This property isinternal to the recipe UI and is available fordebugging and reference purposes only.
StringfileContent
38.0The recipe's publish folder.AssetReferenceInputRepresentationon page 41
folder
38.0A short label for the recipe.Stringlabel
38.0The name of the recipe.Stringname
42.0Small, 42.0The target format or system to publish therecipe to: Dataset, IoT, or DataPool stagingarea.
ConnectRecipePublishingTargetEnumpublishingTarget
38.0The recipe's target dataset's securitypredicate.
StringrowLevelSecurityPredicate
38.0The recipe's schedule dataflow run.Stringschedule
The following JSON shows how to update the name and label of an existing recipe. If the recipe Id is 05vB0000000CacZIAS,thrn the resource endpoint would be /services/data/v41.0/wave/recipes/05vB0000000CacZIAS.
{"name":"This is the new name","label":"This is the new label"
}
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
38.0Recipe JSON file (transforms). ForSalesforce use only.
BinaryrecipeFile
38.0Metadata information such as recipe name,dataflow definition (if any), label, folder,and so on.
Object(RecipeInputRepresentation)
recipeObject
126
Recipe ResourceAnalytics REST API Reference
PATCH Response BodyRecipeRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0Last dataflow update.DatedataflowLastUpdate
38.0Small, 38.0Target DatasetAssetReferenceRepresentation onpage 88
dataset
38.0Small, 38.0URL to get the recipe's file content.StringfileUrl
42.0Small, 42.0The target format or system to publish therecipe to: Dataset, IoT, or DataPool stagingarea.
ConnectRecipePublishingTargetEnumpublishingTarget
38.0Small, 38.0The security predicate of the target datasetStringrowLevelSecurityPredicate
38.0Small, 38.0The schedule cron expression currentdataflow.
Stringschedule
42.0Small, 42.0Target Dataflow ID.StringtargetDataflowId
Recipe File Resource
The recipe's file content.
Resource URL
/wave/recipes/<id>/file
FormatsJSON
Available Version38.0
HTTP MethodsGET
GET Response BodyStreamedRepresentation. Returns a binary stream of the contents of the specified file.
The following is an example JSON representation resulting from the GET method.
{"version":"210.0.0","tableModelInfo":{"fieldAttributes":{
},"rootDataset":{"fetcherType":"EdgemartFetcher","qualifier":"RawEngagementHistory",
127
Recipe File ResourceAnalytics REST API Reference
"label":"RawEngagementHistory","fields":[{"name":"WhatId","label":"What ID"
},{"name":"WhoId","label":"Who ID"
},{"name":"ActivityDate","label":"Activity Date"
},{"name":"ProspectName"
},{"name":"Form.CampaignId.Name"
},{"name":"ActivityType","label":"Activity Type"
},{"name":"CreatedDate","label":"Created Date"
},{"name":"Lead.Name"
},{"name":"Form.CampaignId"
},{"name":"Form.Name"
},{"name":"Contact.Name"
},{"name":"Id","label":"Engagement History ID"
}],"name":"0FbB0000000Csample","devName":"RawEngagementHistory","namespace":null
}},"sampleInfo":{"targetRowSampleSize":5000
},"publishFields":[
128
Recipe File ResourceAnalytics REST API Reference
{"name":"RawEngagementHistory$WhatId","label":"What ID"
},{"name":"calcs$WhatId_substring_textBucket","label":"What ID substring textBucket"
},{"name":"RawEngagementHistory$WhoId","label":"Who ID"
},{"name":"calcs$WhoId_substring_textBucket","label":"Who ID substring textBucket"
},{"name":"RawEngagementHistory$ActivityDate","label":"Activity Date"
},{"name":"RawEngagementHistory$ProspectName"
},{"name":"RawEngagementHistory$Form.CampaignId.Name"
},{"name":"RawEngagementHistory$ActivityType","label":"Activity Type"
},{"name":"RawEngagementHistory$Lead.Name"
},{"name":"RawEngagementHistory$Form.CampaignId"
},{"name":"RawEngagementHistory$Form.Name"
},{"name":"RawEngagementHistory$Contact.Name"
}],"steps":[{"type":"SUBSTRING_FIELD","lastEdit":{"userName":"Donald Go","timeInMs":null
},"sourceField":{"name":"RawEngagementHistory$WhatId","label":"What ID"
},
129
Recipe File ResourceAnalytics REST API Reference
"targetName":"WhatId_substring","targetTableQualifier":"calcs","start":1,"length":3
},{"type":"SUBSTRING_FIELD","lastEdit":{"userName":"Donald Go","timeInMs":null
},"sourceField":{"name":"RawEngagementHistory$WhoId","label":"Who ID"
},"targetName":"WhoId_substring","targetTableQualifier":"calcs","start":1,"length":3
},{"type":"TEXT_CASE_STATEMENT_FIELD","lastEdit":{"userName":"Donald Go","timeInMs":null
},"sourceField":{"name":"calcs$WhatId_substring","label":"What ID substring"
},"targetName":"WhatId_substring_textBucket","targetTableQualifier":"calcs","categoryMappings":{"showUnmappedValuesAsOther":false,"unmappedBucket":"Other","categoryMappings":{"1Mx":"Form"
}}
},{"type":"TEXT_CASE_STATEMENT_FIELD","lastEdit":{"userName":"Donald Go","timeInMs":null
},"sourceField":{"name":"calcs$WhoId_substring","label":"Who ID substring"
},"targetName":"WhoId_substring_textBucket","targetTableQualifier":"calcs","categoryMappings":{"showUnmappedValuesAsOther":false,
130
Recipe File ResourceAnalytics REST API Reference
"unmappedBucket":"Other","categoryMappings":{"00Q":"Lead","003":"Contact"
}}
}],"datasetLabel":"API Test Engagement History"
}
Replicated Datasets Resource
Replicates data from an external Source Object into an Analytics as a dataset. Replicated Datasets are not intended to be visualizeddirectly, but are used like a cache to speed up other workflows which refer to the same source object.
Resource URL
/wave/replicatedDatasets/<ID>
Requires the following permissions:
• orgHasReplicationEnabled
• ELTEditor
• InsightsAdmin
FormatsJSON
Available Version37.0
HTTP MethodsDELETE GET PATCH
GET Response Body
ReplicatedDatasetRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Internal UseDataConnectorRepresentationconnector
38.0Small, 38.0Dataset ID that is associated with thesource object being replicated
StringdatasetId
38.0Small, 38.0Indicates column count for the replicateddataset
IntegerfieldCount
37.0Small, 37.0Url to get the fields associated with thereplicated dataset
StringfieldsUrl
38.0Small, 38.0Indicates if filters have been applied to thereplicated dataset
BooleanfilterApplied
131
Replicated Datasets ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0Indicates if Incremental is on for thereplicated dataset
BooleanincrementalOn
38.0Small, 38.0Indicates the date when the dataset waslast run
DatelastRefreshedDate
38.0Small, 38.0The replicated objects pass through filterstring
StringpassThroughFilter
41.0Small, 41.0Dataflow ID that is associated with runningindividual replication for the object.
StringreplicationDataflowId
37.0Small, 37.0The name of the source object beingreplicated.
StringsourceObjectName
38.0Small, 38.0Current Status of the replicated dataset(Cancelled, Checkpoint, Dequeued,
ReplicatedDataflowStatusEnumstatus
Enqueued, Failure, Initiated, New, Serviced,Stale, Success, Warnings).
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of deep
StringassetSharingUrl
linking. The server examines the linkparameters, which might includeurlType, assetId, orgId, andloginHost, as well as other optionalparameters, and translates as necessary toproduce the correct result on the targetclient. For example, it will open theAnalytics dashboard on desktop clients, ormobile if you are on a mobile OS. Forexample, the shared URL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following web Url:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
Or it might produce the following Url oniOS:
com.salesforce.kona://application/
132
Replicated Datasets ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
36.0Small, 36.0Represents asset creator.WaveUserRepresentation
createdBy
36.0Small, 36.0Time the asset was created.DatecreatedDate
36.0Small, 36.0Short description of the asset.Stringdescription
36.0Small, 36.0The 18 character asset ID.Stringid
36.0Small, 36.0The label of the asset.Stringlabel
36.0Small, 36.0Last time the asset was accessed.DatelastAccessedDate
36.0Small, 36.0The user that last updated the asset.WaveUserRepresentation
lastModifiedBy
36.0Small, 36.0Last time the asset was modified.DatelastModifiedDate
36.0Small, 36.0The name of the asset.Stringname
36.0Small, 36.0The namespace of the Asset.Stringnamespace
36.0Small, 36.0Represents permissions for the presentuser.
PermissionsRepresentation
permissions
36.0Small, 36.0The asset type (Dashboard, DataConnector,DataPoolEntity, DataPoolEntityVersion,
ConnectWaveAssetTypeEnum
type
Dataflow, DataflowJob, Dataset,DatasetShard, DatasetVersion,ExternalData, Folder, Lens, Recipe,ReplicatedDataset, or Workflow).
36.0Small, 36.0URL to get the definition of the asset.Stringurl
PATCH Request Body
ReplicatedDatasetInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Internal use.StringconnectorId
41.0Whether to perform a full refresh asopposed to incremental.
BooleanfullRefresh
133
Replicated Datasets ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0Passthrough filter for the replicated objectStringpassThroughFilter
37.0The name of the source object to bereplicated.
StringsourceObjectName
PATCH Response Body
ReplicatedDatasetRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Internal UseDataConnectorRepresentationconnector
38.0Small, 38.0Dataset ID that is associated with thesource object being replicated
StringdatasetId
38.0Small, 38.0Indicates column count for the replicateddataset
IntegerfieldCount
37.0Small, 37.0Url to get the fields associated with thereplicated dataset
StringfieldsUrl
38.0Small, 38.0Indicates if filters have been applied to thereplicated dataset
BooleanfilterApplied
38.0Small, 38.0Indicates if Incremental is on for thereplicated dataset
BooleanincrementalOn
38.0Small, 38.0Indicates the date when the dataset waslast run
DatelastRefreshedDate
38.0Small, 38.0The replicated objects pass through filterstring
StringpassThroughFilter
41.0Small, 41.0Dataflow ID that is associated with runningindividual replication for the object.
StringreplicationDataflowId
37.0Small, 37.0The name of the source object beingreplicated.
StringsourceObjectName
38.0Small, 38.0Current Status of the replicated dataset(Cancelled, Checkpoint, Dequeued,
ReplicatedDataflowStatusEnumstatus
Enqueued, Failure, Initiated, New, Serviced,Stale, Success, Warnings).
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of deep
StringassetSharingUrl
linking. The server examines the linkparameters, which might includeurlType, assetId, orgId, and
134
Replicated Datasets ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
loginHost, as well as other optionalparameters, and translates as necessary toproduce the correct result on the targetclient. For example, it will open theAnalytics dashboard on desktop clients, ormobile if you are on a mobile OS. Forexample, the shared URL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following web Url:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
Or it might produce the following Url oniOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
36.0Small, 36.0Represents asset creator.WaveUserRepresentation
createdBy
36.0Small, 36.0Time the asset was created.DatecreatedDate
36.0Small, 36.0Short description of the asset.Stringdescription
36.0Small, 36.0The 18 character asset ID.Stringid
36.0Small, 36.0The label of the asset.Stringlabel
36.0Small, 36.0Last time the asset was accessed.DatelastAccessedDate
36.0Small, 36.0The user that last updated the asset.WaveUserRepresentation
lastModifiedBy
36.0Small, 36.0Last time the asset was modified.DatelastModifiedDate
36.0Small, 36.0The name of the asset.Stringname
135
Replicated Datasets ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The namespace of the Asset.Stringnamespace
36.0Small, 36.0Represents permissions for the presentuser.
PermissionsRepresentation
permissions
36.0Small, 36.0The asset type (Dashboard, DataConnector,DataPoolEntity, DataPoolEntityVersion,
ConnectWaveAssetTypeEnum
type
Dataflow, DataflowJob, Dataset,DatasetShard, DatasetVersion,ExternalData, Folder, Lens, Recipe,ReplicatedDataset, or Workflow).
36.0Small, 36.0URL to get the definition of the asset.Stringurl
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
38.0RequiredReplicated Dataset to use to update target.Object (ReplicatedDatasetInputRepresentation)
replicatedDataset
Replicated Datasets List Resource
Returns a list of replicated datasets.
Resource URL
/wave/replicatedDatasets
Requires the following permissions:
• orgHasReplicationEnabled
• ELTEditor
• InsightsAdmin
FormatsJSON
Available Version37.0
HTTP MethodsGET POST
136
Replicated Datasets List ResourceAnalytics REST API Reference
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0The name of the connector.Stringconnector
37.0The name of the source object.StringsourceObject
GET Response Body
ReplicatedDatasetCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0A list of Replicated Datasets.ReplicatedDatasetRepresentation[]
replicatedDatasets
37.0Small, 37.0The URL to get the collection.Stringurl
POST Request Body
ReplicatedDatasetInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Internal use.StringconnectorId
41.0Whether to perform a full refresh asopposed to incremental.
BooleanfullRefresh
38.0Passthrough filter for the replicated objectStringpassThroughFilter
37.0The name of the source object to bereplicated.
StringsourceObjectName
POST Response Body
ReplicatedDatasetRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Internal UseDataConnectorRepresentationconnector
38.0Small, 38.0Dataset ID that is associated with thesource object being replicated
StringdatasetId
38.0Small, 38.0Indicates column count for the replicateddataset
IntegerfieldCount
137
Replicated Datasets List ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Url to get the fields associated with thereplicated dataset
StringfieldsUrl
38.0Small, 38.0Indicates if filters have been applied to thereplicated dataset
BooleanfilterApplied
38.0Small, 38.0Indicates if Incremental is on for thereplicated dataset
BooleanincrementalOn
38.0Small, 38.0Indicates the date when the dataset waslast run
DatelastRefreshedDate
38.0Small, 38.0The replicated objects pass through filterstring
StringpassThroughFilter
41.0Small, 41.0Dataflow ID that is associated with runningindividual replication for the object.
StringreplicationDataflowId
37.0Small, 37.0The name of the source object beingreplicated.
StringsourceObjectName
38.0Small, 38.0Current Status of the replicated dataset(Cancelled, Checkpoint, Dequeued,
ReplicatedDataflowStatusEnumstatus
Enqueued, Failure, Initiated, New, Serviced,Stale, Success, Warnings).
36.0Small, 36.0The URL for opening this asset in theAnalytics builder. This is a form of deep
StringassetSharingUrl
linking. The server examines the linkparameters, which might includeurlType, assetId, orgId, andloginHost, as well as other optionalparameters, and translates as necessary toproduce the correct result on the targetclient. For example, it will open theAnalytics dashboard on desktop clients, ormobile if you are on a mobile OS. Forexample, the shared URL:
http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
Might produce the following web Url:
http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK
138
Replicated Datasets List ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
Or it might produce the following Url oniOS:
com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com
36.0Small, 36.0Represents asset creator.WaveUserRepresentation
createdBy
36.0Small, 36.0Time the asset was created.DatecreatedDate
36.0Small, 36.0Short description of the asset.Stringdescription
36.0Small, 36.0The 18 character asset ID.Stringid
36.0Small, 36.0The label of the asset.Stringlabel
36.0Small, 36.0Last time the asset was accessed.DatelastAccessedDate
36.0Small, 36.0The user that last updated the asset.WaveUserRepresentation
lastModifiedBy
36.0Small, 36.0Last time the asset was modified.DatelastModifiedDate
36.0Small, 36.0The name of the asset.Stringname
36.0Small, 36.0The namespace of the Asset.Stringnamespace
36.0Small, 36.0Represents permissions for the presentuser.
PermissionsRepresentation
permissions
36.0Small, 36.0The asset type (Dashboard, DataConnector,DataPoolEntity, DataPoolEntityVersion,
ConnectWaveAssetTypeEnum
type
Dataflow, DataflowJob, Dataset,DatasetShard, DatasetVersion,ExternalData, Folder, Lens, Recipe,ReplicatedDataset, or Workflow).
36.0Small, 36.0URL to get the definition of the asset.Stringurl
139
Replicated Datasets List ResourceAnalytics REST API Reference
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0RequiredReplicated Dataset to use to update target.Object (ReplicatedDatasetInputRepresentation)
replicatedDataset
Replicated Dataset Fields Resource
A list of Replicated Fields for a particular Replicated Dataset.
Resource URL
/wave/replicatedDatasets/<Id>/fields
Requires the following permissions:
• orgHasReplicationEnabled
• ELTEditor
• InsightsAdmin
FormatsJSON
Available Version37.0
HTTP MethodsGET PATCH
GET Response BodyReplicatedFieldCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0A list of replicated fields.ReplicatedFieldRepresentation[]
fields
37.0Small, 37.0URL to get the collection.Stringurl
ReplicatedFieldRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0If set and true, this field will not bereplicated, but the field metadata can stillbe stored and retrieved.
Booleanskipped
140
Replicated Dataset Fields ResourceAnalytics REST API Reference
PATCH Request BodyReplicatedFieldCollectionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0The list of field configurations.ReplicatedFieldInputRepresentation[]
fields
ReplicatedFieldInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
37.0An optional default value.ObjectdefaultValue
37.0A long-form description of the field.Stringdescription
37.0The type of the field (Date, Numeric, orText).
ConnectWaveFieldTypeEnum
fieldType
37.0For dates, the format string is used to parsethe input value; for other field types,theformat string is used for display.
Stringformat
37.0A user-friendly label for the field.Stringlabel
37.0Indicates if the field is mulit-value or not(default false).
BooleanmultiValue
37.0The value separator, used only if this is amulti-value field.
StringmultiValueSeparator
37.0The field's developer name.Stringname
37.0The numeric precision or text lengthdepending on field type.
Integerprecision
37.0The numeric scale.Integerscale
37.0If set, this field is ignored when replicating.The field metadata is not deleted, however,
Booleanskipped
so the field can be 'unskipped' and madeactive later.
37.0Indicates if the field is a system field(default false). System fields are notqueryable.
BooleansystemField
37.0Indicates if the field is a unique ID for thedata set (default false). There can be onlyone unique ID for any dataset.
BooleanuniqueId
141
Replicated Dataset Fields ResourceAnalytics REST API Reference
PATCH Response BodyReplicatedFieldCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0A list of replicated fields.ReplicatedFieldRepresentation[]
fields
37.0Small, 37.0URL to get the collection.Stringurl
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0RequiredThe field collection for updating thereplicated dataset.
Object (ReplicatedFieldCollectionInputRepresentation)
replicatedFields
Security Coverage Dataset Version Resource
The security coverage for a particular dataset version.
Provides information about the security coverage (sharing inheritance) for a particular dataset version. It lists all source objects that arelocal to this org (no objects from other orgs or other external sources).
Resource URL
/wave/security/coverage/datasets/<datasetIdOrApiName>/versions/<versionId>
FormatsJSON
Available Version41.0
HTTP MethodsGET
GET Response BodyDatasetCoverageRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0Dataset version for which the coverageinformation applies.
DatasetVersionReferenceRepresentation
datasetVersion
41.0Small, 41.0Source objects for the dataset version.DatasetSourceRepresentation[]
sources
142
Security Coverage Dataset Version ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0URL for retrieving this information.Stringurl
DatasetVersionReferenceRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0A reference to the dataset.AssetReferenceRepresentation
dataset
41.0Small, 41.0The 18 character ID of the dataset version.Stringid
41.0Small, 41.0The asset URL.Stringurl
DatasetSourceRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0Source object for a dataset.ObjectCoverageRepresentation
object
41.0Small, 41.0Dataset fields relevant to security for theobject.
String[]securityFields
ObjectCoverageRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0Whether or not the object is an eligiblesharing source.
BooleaneligibleSharingSource
41.0Small, 41.0Label for the object.Stringlabel
41.0Small, 41.0Name of the object.Stringname
41.0Small, 41.0Namespace of the object.Stringnamespace
41.0Small, 41.0URL for retrieving this information.Stringurl
Security Coverage Object Resource
The security coverage for a particular object.
Provides information about whether an object has sharing inheritance support. Supply the objectApiName, and discover whetherAnalytics can inherit sharing settings from it, as well as the object’s label, name, and namespace.
143
Security Coverage Object ResourceAnalytics REST API Reference
Resource URL
/wave/security/coverage/objects/<objectApiName>
FormatsJSON
Available Version41.0
HTTP MethodsGET
GET Response BodyObjectCoverageRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0Whether or not the object is an eligiblesharing source.
BooleaneligibleSharingSource
41.0Small, 41.0Label for the object.Stringlabel
41.0Small, 41.0Name of the object.Stringname
41.0Small, 41.0Namespace of the object.Stringnamespace
41.0Small, 41.0URL for retrieving this information.Stringurl
Templates List Resource
Returns a list of Analytics templates, or adds a template.
Resource URL
/wave/templates
FormatsJSON
Available Version36.0
HTTP MethodsGET POST
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0RequiredConnectWaveTemplateTypeEnum
type • App: An app template.
• Dashboard: A dashboard template.
• Lens: A lens template.
144
Templates List ResourceAnalytics REST API Reference
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The collection of templates availablewithin this organization.
TemplateCollectionRepresentation[]
templates
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0Wave Template Input RepresentationTemplateInputRepresentation
templateParam
POST Request Body
TemplateInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Dataflow associated with this app.AssetReferenceInputRepresentation
dataflow
39.0Folder from which this template shouldbe created from.
AssetReferenceInputRepresentation
folderSource
36.0Short Description of the asset.Stringdescription
36.0The label of the asset.Stringlabel
36.0The name of the asset.Stringname
POST Response BodyTemplateRepresentation
TemplateCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The collection of application templatesavailable within this organization.
TemplateRepresentation[]
templates
Templates Resource
Adds or returns the representation for an Analytics template.
145
Templates ResourceAnalytics REST API Reference
Resource URL
/wave/templates/<templateIdOrApiName>
FormatsJSON
Available Version36.0
HTTP MethodsDELETE GET PUT
GET Response Body
TemplateRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0 to 41.0Small, 36.0The icon that best represents the Analyticsapplication.
StringassetIcon
37.0Big, 37.0Asset version (api version) of all thedashboards and lenses.
DoubleassetVersion
36.0Small, 36.0The URL to the configuration of thetemplate.
StringconfigurationUrl
36.0Big, 36.0The description of the applicationtemplate.
Stringdescription
39.0Medium, 39.0The folder source of this templateAssetReferenceRepresentation
folderSource
41.0Small, 41.0The icons configured for this wavetemplate.
TemplateIconsRepresentationicons
36.0Small, 36.0The ID or fully qualified API name of thistemplate.
Stringid
36.0Small, 36.0The localized name of the applicationtemplate.
Stringlabel
36.0Medium, 36.0The local API name of the applicationtemplate.
Stringname
36.0Medium, 36.0The namespace of the applicationtemplate provider.
Stringnamespace
37.0Medium, 37.0The release information for this templateTemplateReleaseRepresentation
releaseInfo
36.0 to 41.0Small, 36.0The icon that best represents the Analyticsapplication template.
StringtemplateIcon
146
Templates ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The template type, if empty or null thentemplate type is app.
ConnectWaveTemplateTypeEnum
templateType
• App
• Dashboard
• Lens
36.0Small, 36.0The URL to the detail of the template.Stringurl
TemplateIconsRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0The badge icon used on any app createdfrom this template.
AssetReferenceRepresentationappBadge
41.0Small, 41.0The badge icon used to represent thistemplate in the template configurationwizard.
AssetReferenceRepresentationtemplateBadge
41.0Small, 41.0The icon/image used to display on thetemplate detail page when the templateis selected in the wizard.
AssetReferenceRepresentationtemplateDetail
PUT Request BodyTemplateInputRepresentation
PUT Response BodyTemplateRepresentation
PUT Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
39.0Analytics Template Input RepresentationTemplateInputRepresentation onpage 145
templateParam
TemplateReleaseRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0The URL to the release notes for thistemplate
StringnotesUrl
147
Templates ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0The version of this template.StringtemplateVersion
Templates Configuration Resource
Returns the configuration of an Analytics template.
Resource URL
/wave/templates/<templateIdOrApiName>/configuration
FormatsJSON
Available Version36.0
HTTP MethodsGET
GET Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
36.0OptionalDisables any apex integration hooks if true.Default is false.
BooldisableApex
GET Response Body
TemplateConfigurationRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The user interface definition for thetemplate.
Wave UI Definitionui
36.0Small, 36.0The defined set of variables for thetemplate.
Map <String, WaveVariable Definition>
variables
Wave UI Definition
UiDefinitionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The display messages for this templateconfiguration.
DisplayMessageRepresentation[]
displayMessages
148
Templates Configuration ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The page collection for this templateconfiguration.
Page[]pages
DisplayMessageRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The name of the page where the text isto be displayed.
Stringlocation
36.0Small, 36.0Text content to display.Stringtext
Page
PageRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The optional condition in which the pageshould be shown. Values should be
Stringcondition
client-side EL notation (e.g.{{Variables.selectedOption}}).
36.0Small, 36.0An URL to this page's help webpage.StringhelpUrl
36.0Small, 36.0The title for the page.Stringtitle
36.0Small, 36.0The collection of variables for thistemplate configuration.
PageVariableRepresentation onpage 149[]
variables
40.0Small, 40.0The visualforce page to be used as theuser interface instead of the standardwizard interface.
AssetReferenceRepresentationvfPage
PageVariableRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The name of a variable.Stringname
36.0Small, 36.0The visibility expression for this variableStringvisibility
149
Templates Configuration ResourceAnalytics REST API Reference
Wave Variable Definition
VariableDefinitionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 38.0The computed value of the variable. Thisvalue is set by integrated apeximplementations.
ObjectcomputedValue
36.0Small, 36.0The default value of the variable.ObjectdefaultValue
36.0Small, 36.0The description of the variable.Stringdescription
36.0Small, 36.0True if the variable hasexcludeSelected in the template.Otherwise False.
BooleanexcludeSelected
36.0Small, 36.0List of values to exclude from the variableselection.
String[]excludes
36.0Small, 36.0The label for the variable.Stringlabel
36.0Small, 36.0The value specified in the most recentapp creation process.
ObjectmostRecentValue
36.0Small, 36.0True if this variable is required by thetemplate. Otherwise False
Booleanrequired
36.0Small, 36.0The type of the variable.VariableTypeRepresentation
variableType
VariableTypeRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The type of the variable:VariableTypeEnumtype
• ArraytType: The variable type is anarray of objects.
• BooleanType: The variable type is oftype boolean (true, false).
• DatasetDateType: The variable type isdate within a dataset.
• DatasetDimensionType: The variabletype is dimension within a dataset.
• DatasetMeasureType: The variable typeis measure within a dataset.
150
Templates Configuration ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
• DatasetType: The variable type isdataset type that references a datasetwithin your organization.
• DateTimeType: The variable type is oftype date/time.
• NumberType: Restricts user input tovalues of numeric type.
• ObjectType: The variable type is anarbitrary object.
• SobjectFieldType: The variable type issObject-field, or references a fieldwithin an sObject. See also sObjectvariable type.
• SobjectType: The variable type is oftype sObject, or should reference ansObject within your organization.
• StringType: The variable type is of typestring
Example Response Body
{"ui": {
"pages": [{
"title": "Application Preferences","variables": [
"lensDashboardName","dashboardHeader"
]},{
"title": "Other preferences","variables": [
"emailNotifications","emailAddress"
]}
]},"variables": {
"numberPicked": {"defaultValue": 3,"description": "A number between 1 and 10.","excludeSelected": false,
151
Templates Configuration ResourceAnalytics REST API Reference
"excludes": [],"label": "Please pick a number between 1 and 10?","required": true,"variableType": {
"enums": [],"max": 10,"min": 1,"type": "NumberType"
}},"lensDashboardName": {
"defaultValue": "My View of Election Data","description": "The name of the sample lens.","excludeSelected": false,"excludes": [],"label": "What would you like to name your lens and dashboard?","required": true,"variableType": {
"enums": [],"type": "StringType"
}},"dashboardHeader": {
"defaultValue": "Wow! Interactive Dashboards are Nice!","description": "The dashboard header.","excludeSelected": false,"excludes": [],"label": "What would you like the dashboard header to say?","required": true,"variableType": {
"enums": [],"type": "StringType"
}},"emailNotifications": {
"defaultValue": "Yes","description": "Email notifications","excludeSelected": false,"excludes": [],"label": "Would you like to receive emails for promotions?","required": false,"variableType": {
"enums": ["Yes","No"
],"type": "StringType"
}},"emailAddress": {
"defaultValue": null,"description": "Your email address.","excludeSelected": false,"excludes": [],
152
Templates Configuration ResourceAnalytics REST API Reference
"label": "Please enter your email address?","required": false,"variableType": {
"enums": [],"type": "StringType"
}}
}}
Template Release Notes Resource
Resource for retrieving the release notes for a single Analytics Template.
Resource URL
/wave/templates/<templateIdOrApiName>/releasenotes
FormatsJSON
Available Version37.0
HTTP MethodsGET
GET Response BodyTemplateReleaseNotesRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0The release note's markdown.Stringnotes
Trended Reports List Resource
Returns or adds to a collection of Trending Reports.
Resource URL
/wave/trendedreports
FormatsJSON
Available Version37.0
HTTP MethodsGET POST
153
Template Release Notes ResourceAnalytics REST API Reference
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0A collection of trended reports.TrendedReportRepresentation[]
trendedReports
37.0Small, 37.0URL to get the collection.Stringurl
POST Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0Reference to the apex class to execute aftersuccessful trending.
AssetReferenceInputRepresentation
apexHooksClass
37.0Label for the Analytics Dashboard that willbe created.
StringdashboardLabel
37.0Reference to the report being trended.StringdatasetLabel
37.0Reference to the report being trended.AssetReferenceInputRepresentation
report
39.0Schedule on which the trending shouldbe run.
DailyScheduleInputRepresentation,WeeklySchedule
schedule
InputRepresentation,MonthlyRelativeScheduleInputRepresentation,MonthlySpecificScheduleInputRepresentation
POST Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 37.0Reference to the apex class which is usedfor post processing each time the reportis trended.
AssetReferenceRepresentation
apexHooksClass
37.0Small, 37.0Reference to the Dashboard for thetrended report.
AssetReferenceRepresentation
dashboard
154
Trended Reports List ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
37.0Small, 37.0Reference to the Dataset with the trendedreport data.
AssetReferenceRepresentation
dataset
37.0Small, 37.0The 18 character ID of the trended report.Stringid
37.0Small, 37.0Reference to the Report that is beingtrended.
AssetReferenceRepresentation
report
39.0Small, 39.0Schedule of when this report is trended.DailyScheduleRepresentation,
Schedule
WeeklyScheduleRepresentation,MonthlyRelativeScheduleRepresentation,MonthlySpecificScheduleRepresentation
37.0Small, 37.0The URL for the trended report.Stringurl
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
37.0RequiredThe trended report to add.Object (TrendedReportInputRepresentation)
trendedReport
DailyScheduleInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0How often the schedule should be run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0When the schedule should be run.TimeInputRepresentation
time
155
Trended Reports List ResourceAnalytics REST API Reference
WeeklyScheduleInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0How often the schedule should be run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0When the schedule should be run.TimeInputRepresentation
time
39.0Days of the week on which the schedulewill run (Monday, Tuesday, Wednesday,Thursday, Friday, Saturday, Sunday).
ConnectWaveDayOfWeekEnum[]
daysOfWeek
MonthlyRelativeScheduleInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0How often the schedule should be run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0When the schedule should be run.TimeInputRepresentation
time
39.0Day of the week when the schedule shouldbe run (Monday, Tuesday, Wednesday,Thursday, Friday, Saturday, Sunday).
ConnectWaveDayOfWeekEnum
dayInWeek
39.0Relative week in the month when theschedule should be run (First, Second,Third, Fourth, Last).
ConnectWaveRelativeWeekEnum
weekInMonth
MonthlySpecificScheduleInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0How often the schedule should be run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0When the schedule should be run.TimeInputRepresentation
time
39.0Days of the month on which the schedulewill run (1-31). Note that months lackingspecific days will skip the job.
Integer[]daysOfMonth
156
Trended Reports List ResourceAnalytics REST API Reference
TimeInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Hour on which the schedule should be run(in the user's time zone).
Integerhour
DailyScheduleRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0Frequency on which this schedule is run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0Small, 39.0Hour and timezone in which this scheduleis run.
TimeRepresentationtime
WeeklyScheduleRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0Frequency on which this schedule is run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0Small, 39.0Hour and timezone in which this scheduleis run.
TimeRepresentationtime
39.0Small, 39.0Days of the week on which the schedulewill run (Monday, Tuesday, Wednesday,Thursday, Friday, Saturday, Sunday).
ConnectWaveDayOfWeekEnum[]
daysOfWeek
MonthlyRelativeScheduleRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0Frequency on which this schedule is run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0Small, 39.0Hour and timezone in which this scheduleis run.
TimeRepresentationtime
157
Trended Reports List ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0Day within a week (Monday, Tuesday,Wednesday, Thursday, Friday, Saturday,Sunday).
ConnectWaveDayOfWeekEnum
dayInWeek
39.0Small, 39.0Week within a month (First, Second, Third,Fourth, Last).
ConnectWaveRelativeWeekEnum
weekInMonth
MonthlySpecificScheduleRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0Frequency on which this schedule is run(Daily, Monthly, MonthlyRelative, orWeekly).
ConnectWaveScheduleFrequencyTypeEnum
frequency
39.0Small, 39.0Hour and timezone in which this scheduleis run.
TimeRepresentationtime
39.0Small, 39.0Days of the month on which the schedulewill run (-1, 1-31). Note that months
Integer[]daysOfMonth
lacking specific days will skip the job. Canspecify a single value of -1 to indicate thelast day of the month (-1 cannot be usedwith additional days).
TimeRepresentation>
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0Hour at which this schedule is run (0-23).Integerhour
39.0Small, 39.0Time zone of the hour at which theschedule is run.
TimeZoneRepresentation
timeZone
TimeZoneRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
39.0Small, 39.0The signed offset, in hours, from GMT.DoublegmtOffset
39.0Small, 39.0The display name of this time zone.Stringname
158
Trended Reports List ResourceAnalytics REST API Reference
Trended Reports Resource
Returns, deletes, or updates a Trending Report.
Resource URL
/wave/trendedreports/<Id>
FormatsJSON
Available Version37.0
HTTP MethodsDELETE GET PATCH
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 37.0Reference to the apex class which is usedfor post processing each time the reportis trended.
AssetReferenceRepresentation
apexHooksClass
37.0Small, 37.0Reference to the Dashboard for thetrended report.
AssetReferenceRepresentation
dashboard
37.0Small, 37.0Reference to the Dataset with the trendedreport data.
AssetReferenceRepresentation
dataset
37.0Small, 37.0The 18 character ID of the trended report.Stringid
37.0Small, 37.0Reference to the Report that is beingtrended.
AssetReferenceRepresentation
report
39.0Small, 39.0Schedule of when this report is trended.DailyScheduleRepresentation,
Schedule
WeeklyScheduleRepresentation,MonthlyRelativeScheduleRepresentation,MonthlySpecificScheduleRepresentation
37.0Small, 37.0The URL for the trended report.Stringurl
159
Trended Reports ResourceAnalytics REST API Reference
PATCH Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0Reference to the apex class to execute aftersuccessful trending.
AssetReferenceInputRepresentation
apexHooksClass
37.0Label for the Analytics Dashboard that willbe created.
StringdashboardLabel
37.0Reference to the report being trended.StringdatasetLabel
37.0Reference to the report being trended.AssetReferenceInputRepresentation
report
39.0Schedule on which the trending shouldbe run.
DailyScheduleInputRepresentation,WeeklySchedule
schedule
InputRepresentation,MonthlyRelativeScheduleInputRepresentation,MonthlySpecificScheduleInputRepresentation
PATCH Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
38.0Small, 37.0Reference to the apex class which is usedfor post processing each time the reportis trended.
AssetReferenceRepresentation
apexHooksClass
37.0Small, 37.0Reference to the Dashboard for thetrended report.
AssetReferenceRepresentation
dashboard
37.0Small, 37.0Reference to the Dataset with the trendedreport data.
AssetReferenceRepresentation
dataset
37.0Small, 37.0The 18 character ID of the trended report.Stringid
37.0Small, 37.0Reference to the Report that is beingtrended.
AssetReferenceRepresentation
report
39.0Small, 39.0Schedule of when this report is trended.DailyScheduleRepresentation,
Schedule
WeeklyScheduleRepresentation,MonthlyRelative
160
Trended Reports ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
ScheduleRepresentation,MonthlySpecificScheduleRepresentation
37.0Small, 37.0The URL for the trended report.Stringurl
PATCH Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
38.0RequiredThe object with which to update thetrended report.
Object (TrendedReportInputRepresentation)
trendedReport
Dataset Versions List Resource
Returns a collection of dataset versions for a particular dataset.
Resource URL
/wave/datasets/<datasetIdOrApiName>/versions
FormatsJSON
Available Version36.0
HTTP MethodsGET POST
GET Response BodyDatasetVersionCollectionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The URL to retrieve the collection.Stringurl
36.0Small, 36.0The collection of dataset versions for aparticular dataset.
Dataset Version[]versions
161
Dataset Versions List ResourceAnalytics REST API Reference
Example Response Body
{"url" : "/services/data/v41.0/wave/datasets/0Fb4000000000FtCAI/versions","versions" : [ {"createdBy" : {"id" : "00540000000DhrEAAS","name" : "Integration User","profilePhotoUrl" :
"https://https://yourInstance.salesforce.com/profilephoto/005/T"},"createdDate" : "2015-05-20T23:19:33.000Z","dataset" : {"id" : "0Fb4000000000FtCAI","url" : "/services/data/v41.0/wave/datasets/0Fb4000000000FtCAI"
},"files" : [ ],"id" : "0Fc4000000001VOCAY","lastModifiedBy" : {"id" : "00540000000DhrEAAS","name" : "Integration User","profilePhotoUrl" :
"https://https://yourInstance.salesforce.com/profilephoto/005/T"},"lastModifiedDate" : "2015-05-20T23:19:49.000Z","permissions" : {"modify" : true,"view" : true
},"type" : "datasetversion","url" :
"/services/data/v41.0/wave/datasets/0Fb4000000000FtCAI/versions/0Fc4000000001VOCAY","xmdsUrl" :
"/services/data/v41.0/wave/datasets/0Fb4000000000FtCAI/versions/0Fc4000000001VOCAY/xmds"
} ]}
POST Request BodyRestoreDatasetVersionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
41.0Source version to restore.AssetReferenceInputRepresentationon page 41
sourceVersion
162
Dataset Versions List ResourceAnalytics REST API Reference
POST Request Parameters
AvailableVersion
Required orOptional
DescriptionTypeParameterName
41.0Source version to restore.Object (RestoreDatasetVersionInput
sourceVersion
Representation onpage 163)
RestoreDatasetVersionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
41.0Source version to restore.AssetReferenceInputRepresentationon page 41
sourceVersion
POST Response BodyRestoreDatasetVersionRepresentation
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
41.0Small, 41.0Collection of dataset versions for aparticular dataset.
Stringmessage
41.0Small, 41.0URL to get the status.Stringurl
Dataset Version Resource
Returns an Analytics dataset version (GET), or updates the predicate (PATCH).
Resource URL
/wave/datasets/<datasetIdOrApiName>/versions/<version ID>
FormatsJSON
Available Version36.0
HTTP MethodsGET and PATCH
163
Dataset Version ResourceAnalytics REST API Reference
GET and PATCH Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The creator of the dataset.Wave UsercreatedBy
36.0Small, 36.0The time at which the dataset was created,in ISO8601 date format.
DatecreatedDate
36.0Small, 36.0A reference to the dataset.Dataset Referencedataset
36.0Medium, 36.0List of information about the data files thatmake up the dataset version.
WaveFileMetadataRepresentation[]
files
36.0Small, 36.0The 18-character dataset ID.IDid
36.0Small, 36.0The user who last updated the dataset.Wave UserlastModifiedBy
36.0Small, 36.0The last time the dataset was modified, inISO8601 date format.
DatelastModifiedDate
36.0Small, 36.0The permissions for the current user.Permissionspermissions
36.0Small, 36.0The row-level security predicate. Onlyreturned if the predicate is set in the inputrequest.
Stringpredicate
36.0Small, 36.0The version of the row-level securitypredicate. Only returned if the predicate isset in the input request.
DoublepredicateVersion
41.0Small, 41.0Dataset sharing inheritance coverageinformation resource.
StringsecurityCoverageUrl
40.0Small, 40.0Entity from which sharing rules will beinherited for this dataset version.
AssetReferenceRepresentationsharingSource
40.0Small, 40.0Total number of rows for this datasetversion.
IntegertotalRows
36.0Small, 36.0The asset type. For dataset versions, thevalue is datasetversion.
Stringtype
36.0Small, 36.0The URL of the files resource for thisdataset version.
StringfilesUrl
36.0Medium, 36.0The extended metadata (XMD) for thisdataset version.
XMDxmdMain
36.0Small, 36.0The URL of the XMD collection resourcefor this dataset version.
StringxmdsUrl
164
Dataset Version ResourceAnalytics REST API Reference
Dataset Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The 18-character ID of the dataset.IDid
36.0Small, 36.0The URL of the dataset.Stringurl
Example Response Body
{"createdBy" : {"id" : "005D0000001VHeYIAW","name" : "Integration User","profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
},"createdDate" : "2015-04-20T20:17:54.000Z","dataset" : {"id" : "0FbD00000004CoMKAU","url" : "/services/data/v36.0/wave/datasets/0FbD00000004CoMKAU"
},"files" : [ ],"id" : "0FcD00000004DRyKAM","lastModifiedBy" : {"id" : "005D0000001VHeYIAW","name" : "Integration User","profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
},"lastModifiedDate" : "2015-04-20T20:18:14.000Z","permissions" : {"modify" : true,"view" : true
},"type" : "datasetversion","url" :
"/services/data/v36.0/wave/datasets/0FbD00000004CoMKAU/versions/0FcD00000004DRyKAM"}
PATCH Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Indicates whether the Dataset Version iscomplete
BooleanisComplete
36.0The row level security predicate to beapplied to this Dataset Version.
Stringpredicate
40.0Entity from which sharing rules should beinherited.
AssetReferenceInputRepresentationsharingSource
165
Dataset Version ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The total number of rows that make upthe Dataset Version
IntegertotalRows
Example Request Body
{"predicate" : "<predicate value>"
}
PATCH Response BodyDataset Version
XMD List Resource
Returns a list of XMD resources for a version of a dataset.
Resource URL
/wave/datasets/<datasetIdOrApiName>/versions/<version ID>/xmds
FormatsJSON
Available Version36.0
HTTP MethodsGET
GET Response Body
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The location of the XMD collection.Stringurl
36.0Small, 36.0The list of XMD resources.XMD Metadata[]xmds
XMD Metadata
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The type of XMD. Values are:Stringtype
• main
• system
• user
36.0Small, 36.0The location of this XMD.Stringurl
166
XMD List ResourceAnalytics REST API Reference
Example Response Body
{"url" :
"/services/data/v36.0/wave/datasets/0Fb4000000000FtCAI/versions/0Fc4000000001VOCAY/xmds",
"xmds" : [ {"type" : "main","url" :
"/services/data/v36.0/wave/datasets/0Fb4000000000FtCAI/versions/0Fc4000000001VOCAY/xmds/main"
}, {"type" : "user","url" :
"/services/data/v36.0/wave/datasets/0Fb4000000000FtCAI/versions/0Fc4000000001VOCAY/xmds/user"
}, {"type" : "system","url" :
"/services/data/v36.0/wave/datasets/0Fb4000000000FtCAI/versions/0Fc4000000001VOCAY/xmds/system"
} ]}
XMD Resource
Returns the extended metadata (XMD) for a version of a dataset (GET) and replaces the user XMD file (PUT).
Resource URL
/wave/datasets/<dataset ID>/versions/<version ID>/xmds/main
/wave/datasets/<dataset ID>/versions/<version ID>/xmds/system
/wave/datasets/<dataset ID>/versions/<version ID>/xmds/user
For full details on XMD, refer to the Analytics Extended Metadata (XMD) Reference.
FormatsJSON
Available Version36.0
HTTP MethodsGET and PUT (on /wave/datasets/<dataset ID>/versions/<version ID>/xmds/user only)
GET Response Body
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The creator of the XMD.Wave UsercreatedBy
36.0Small, 36.0The time at which the XMD wascreated, in ISO8601 date format.
DatecreatedDate
167
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0A list of dates with formattinginformation.
XMD Date[]dates
36.0Small, 36.0A list of derived dimensions withformatting information.
XMDDimension[]
derivedDimensions
36.0Small, 36.0List of derived measures withformatting information.
XMD Measure[]derivedMeasures
36.0Small, 36.0List of dimensions with formattinginformation.
XMDDimension[]
dimensions
37.0Small, 37.0Message if there was error copyingforward the current version's userXMD to the newly created version.
StringerrorMessage
36.0Small, 36.0The language in which this XMD islocalized. Values are:
Stringlanguage
• bg: Bulgarian
• zh_CN: Chinese Simplified
• zh_TW: Chinese Traditional
• hr: Croatian
• cs: Czech
• da: Danish
• nl_NL: Dutch
• en: English
• en_GB: English (UnitedKingdom)
• fi: Finnish
• fr: French
• de: German
• el: Greek
• hu: Hungarian
• in: Indonesian
• it: Italian
• ja: Japanese
• ko: Korean
• no: Norwegian
• pl: Polish
• pt_PT: Portuguese (Portugal)
• pt_BR: Portuguese (Brazil)
• ro: Romanian
168
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
• ru: Russian
• sk: Slovak
• sl: Slovenian
• es: Spanish
• es_MX: Spanish (Mexico)
• sv: Swedish
• th: Thai
• tr: Turkish
• uk: Ukrainian
• vi: Vietnamese
36.0Small, 36.0The user who last updated the XMD.Wave UserlastModifiedBy
36.0Small, 36.0The last time the XMD was modified,in ISO8601 date format.
DatelastModifiedDate
36.0Small, 36.0List of measures with formattinginformation.
XMD Measure[]measures
36.0Small, 36.0List of organizations formulti-organization support.
XMDOrganization[]
organizations
36.0Small, 36.0Ordered list of dimensions andmeasures. The list defines the
String[]showDetailsDefaultFields
default order in which to show thedimensions and measures in theuser interface.
36.0Small, 36.0The type of XMD. Values are:Stringtype
• main
• system
• user
36.0Small, 36.0The location where this XMD isstored.
Stringurl
XMD Date
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Alias of the Date column.Stringalias
36.0Small, 36.0Formatting information for thedate fields.
XMD Date Fieldfields
169
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0What the first day of the week is.IntegerfirstDayOfWeek
36.0Small, 36.0Offset number of months for thefiscal year in relation to thecalendar year.
IntegerfiscalMonthOffset
39.0Small, 39.0Fully qualified name of the date.StringfullyQualifiedName
36.0Small, 36.0Label of the Date column.Stringlabel
XMD Date Field
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The day of the month.Stringday
36.0Small, 36.0Number of days that have elapsed sinceJanuary 1, 1970 (midnight UTC).
StringepochDay
36.0Small, 36.0Number of seconds that have elapsedsince January 1, 1970 (midnight UTC).Corresponds to _sec_epoch in datasets.
StringepochSecond
36.0Small, 36.0Month number in fiscal year. Correspondsto _Month_Fiscal in datasets.
StringfiscalMonth
36.0Small, 36.0Quarter number in fiscal year.Corresponds to _Quarter_Fiscal indatasets.
StringfiscalQuarter
36.0Small, 36.0Week number in fiscal year. Correspondsto _Week_Fiscal in datasets.
StringfiscalWeek
36.0Small, 36.0The Fiscal year. Corresponds to_Year_Fiscal in datasets.
StringfiscalYear
36.0Small, 36.0The full-field field.StringfullField
36.0Small, 36.0Number of hours. If the date contains nohours, value is '0.' Corresponds to _Hourin datasets.
Stringhour
36.0Small, 36.0Number of minutes. If the date containsno minutes, value is '0.' Corresponds to_Minute in datasets.
Stringminute
36.0Small, 36.0Month number in calendar year.Corresponds to _Month is datasets.
Stringmonth
36.0Small, 36.0Quarter number in calendar year.Corresponds to _Quarter in datasets.
Stringquarter
170
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Number of seconds. If the date containsno seconds, value is '0.' Corresponds to_Second in datasets.
Stringsecond
36.0Small, 36.0Week number in calendar year.Corresponds to _Week in datasets.
Stringweek
36.0Small, 36.0The calendar year. Corresponds to _Yearin datasets.
Stringyear
XMD Dimension
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0The field name of the dimension(used in queries).
Stringfield
36.0Small, 36.0Display name for the dataset field.Can be up to 40 characters.
Stringlabel
36.0Small, 36.0The URL to open when the userclicks the link in the actions menu.
StringlinkTemplate
Overrides the default URL link,which is"/{{row.recordIdField}}".The default finds the Salesforcerecord with the record ID specifiedin the recordIdField XMDparameter. Must be 255 charactersor less. To open a Salesforcerecordfrom a multi-orgenvironment, enter {{instanceUrl}}to populate the org URL specifiedin the“organizations” section of theXMD. Example:"/{{row.dimensionNameId}}".
36.0Small, 36.0Display the link to open aSalesforce record or URL. If set to
BooleanlinkTemplateEnabled
false or not set, the menu doesn'tdisplay the Open Record linkoption.
36.0Small, 36.0The tooltip that a dashboard viewersees when they hover over the linkin an Analytics lens or dashboard.
StringlinkTooltip
36.0Small, 36.0Customizations for specific valuesof the dataset fields. For example,
XMD DimensionMember[]
members
171
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
for the "Country" field, change thelabel of the "USA" to "UnitedStates." And change the color forthis value in a chart to blue.
Note: When you changethe label, the new label onlyappears in the userinterface. You can’t use thelabel in queries, like a queryfilter. For this, the bestpractice is to modify thefield values when youcreate the dataset.
36.0Small, 36.0Ordered list of dimensions andmeasures. These dataset fields are
String[]recordDisplayFields
used to help a dashboard vieweridentify a Salesforce record whenmultiple records match the action.For each field, specify its API name.In some instances, a dimensionvalue is associated with multipleIDs and isn’t unique. For example,an opportunity with the name“acme” has multiple opportunityIDs (and records). But the action orlink can only be directed to onerecord.
36.0Small, 36.0The dataset field that contains therecord ID of the Salesforce object
StringrecordIdField
that you want to perform theaction on.
36.0Small, 36.0The record organization ID for thisdimension.
StringrecordOrganizationIdField
36.0Small, 36.0Actions that appear in the actionmenu. You can only add actions
XMD DimensionSalesforceAction[]
salesforceActions
that are defined in the page layoutsfor the corresponding Salesforceobject. If left blank, Analytics showsall actions.
36.0Small, 36.0Enables a Salesforce actions menuto appear on the field. If set to false
BooleansalesforceActionsEnabled
or not set, the menu doesn'tdisplay any actions.
172
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Determines whether the datasetfield can be selected from the
BooleanshowInExplorer
dashboard designer or explorerwhen creating dashboards andlenses. Even if showInExplorer isfalse, the field can still be used forSAQL queries, manually added inJSON, and accessed using theAnalytics REST API.
XMD Dimension Member
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The color for the member. For example,set to “Blue”.
Stringcolor
36.0Small, 36.0The label for the member. For example,set to “United States”.
Stringlabel
36.0Small, 36.0The member value. For example, set to“USA”.
Stringmember
XMD Dimension Salesforce Action
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0Indicates whether the action is enabledfor a specific dimension.
Booleanenabled
36.0Small, 36.0The name of the action.Stringname
XMD Measure
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Identifier (API name) for the datasetfield.
Stringfield
36.0Small, 36.0The format details for the measure.XMD MeasureFormat
format
173
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0Display name for the dataset field.Can be up to 40 characters. Forexample, “Sales Amount".
Stringlabel
36.0Small, 36.0Determines whether the datasetfield can be selected from the
BooleanshowInExplorer
dashboard designer or explorerwhen creating dashboards andlenses. Even if showInExplorer isfalse, the field can still be used forSAQL queries, manually added inJSON, and accessed using theAnalytics REST API.
XMD Measure Format
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
36.0Small, 36.0When customizing the display, youcan add a prefix, suffix, grouping
StringcustomFormat
separator, decimal separator, andleading and trailing zeros. You canalso configure the number of digits.You can include any characters inprefixes and suffixes, includingminus signs or currency symbols.You can use the following symbolsto specifying a format.
• 0. One digit. Use to add leadingor trailing 0s. For example, ifyou apply custom format#,###.00 to 56375, the result is56,375.00.
• #. Adds zero or one digit. Useto show digits whenapplicable. For example, if youapply custom format #,###.##to 56375.56, the result is56,375.56.
• .(period). Symbol used as thedecimal separator, like in thenumber 375.56. Analyticscurrently only supports the
174
XMD ResourceAnalytics REST API Reference
AvailableVersion
Filter Groupand Version
DescriptionTypeProperty Name
decimal symbol (.) as a decimalseparator.
• ,(comma). Symbol used as thegrouping separator, like in56,375. Analytics currently onlysupports the comma symbol(,) as a grouping separator.Example: [\"-$#,###.00$\",1]
36.0Small, 36.0The multiplier for the unit. Themultiplier changes a field’s values
DoubleunitMultiplier
by the same factor—likemultiplying by 100 to convertdecimals to percents.The multipliermust be a positive number.
XMD Organization
AvailableVersion
Filter Group andVersion
DescriptionTypeProperty Name
36.0Small, 36.0The ID of the organization.Stringid
36.0Small, 36.0URL of the Salesforce org. If a customdomain name is set up for the org, it’s thedomain name for the org.
StringinstanceUrl
36.0Small, 36.0Display name for the Salesforce org. Canbe up to 40 characters.
Stringlabel
PUT Request Body
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Locale-specific information about theDataset represented by this XMD.
XmdDatasetInputRepresentation
dataset
36.0List of dates with formatting information.XmdDateInputRepresentation[]
dates
36.0List of derived dimensions with formattinginformation.
XmdDerivedDimensionInputRepresentation[]
derivedDimensions
175
XMD ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0List of derived measures with formattinginformation.
XmdDerivedMeasureInputRepresentation[]
derivedMeasures
36.0List of dimensions with formattinginformation.
XmdDimensionInputRepresentation[]
dimensions
36.0List of measures with formattinginformation.
XmdMeasureInputRepresentation[]
measures
36.0List of organizations for multi-organizationsupport.
XmdOrganizationInputRepresentation[]
organizations
36.0Ordered list of Dimensions and Measures.Represents the default order to show themin the UI.
String[]showDetailsDefaultFields
XmdDatasetInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Connector source for the dataset.Stringconnector
36.0Description of the dataset.Stringdescription
36.0Fully qualified name of the dataset version.StringfullyQualifiedName
36.0Origin representing where this datasetversion comes from.
Stringorigin
XmdDateInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Alias of the Date column.Stringalias
36.0Formatting information for the date fields.XmdDateFieldsInputRepresentation
fields
36.0What the first day of the week is.IntegerfirstDayOfWeek
36.0Offset number of months for the fiscal yearin relation to the calendar year.
IntegerfiscalMonthOffset
176
XMD ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
39.0Fully qualified name of the date.StringfullyQualifiedName
36.0Label of the Date column.Stringlabel
XmdDateFieldsInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The day of the month.Stringday
36.0Number of days that have elapsed sinceJanuary 1, 1970 (midnight UTC).
StringepochDay
36.0Number of seconds that have elapsedsince January 1, 1970 (midnight UTC).Corresponds to _sec_epoch in datasets.
StringepochSecond
36.0Month number in fiscal year. Correspondsto _Month_Fiscal in datasets.
StringfiscalMonth
36.0Quarter number in fiscal year. Correspondsto _Quarter_Fiscal in datasets.
StringfiscalQuarter
36.0Week number in fiscal year. Correspondsto _Week_Fiscal in datasets.
StringfiscalWeek
36.0The Fiscal year. Corresponds to_Year_Fiscal in datasets.
StringfiscalYear
36.0fullField field.StringfullField
36.0Number of hours. If the date contains nohours, value is '0.' Corresponds to _Hourin datasets.
Stringhour
36.0Number of minutes. If the date containsno minutes, value is '0.' Corresponds to_Minute in datasets.
Stringminute
36.0Month number in calendar year.Corresponds to _Month is datasets.
Stringmonth
36.0Quarter number in calendar year.Corresponds to _Quarter in datasets.
Stringquarter
36.0Number of seconds. If the date containsno seconds, value is '0.' Corresponds to_Second in datasets.
Stringsecond
36.0Week number in calendar year.Corresponds to _Week in datasets.
Stringweek
177
XMD ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The calendar year. Corresponds to _Yearin datasets.
Stringyear
XmdDerivedDimensionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Customizations for specific values of thedataset fields. For example, change thecolor for this value in a chart to blue.
XmdDerivedDimensionMemberInputRepresentation[]
members
Note: When you change the label,the new label only appears in theuser interface. You can’t use thelabel in queries, like a query filter.For this, the best practice is tomodify the field values when youcreate the dataset.
36.0Actions that appear in the action menu.You can only add actions that are defined
XmdDerivedDimension
salesforceActions
in the page layouts for the correspondingSalesforceActionSalesforce object. If left blank, Analyticsshows all actions.
InputRepresentation[]
XmdDerivedDimensionMemberInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The color for the member. For example,set to “Blue”.
Stringcolor
36.0The label for the member. For example,set to “United States”.
Stringlabel
36.0The member value. For example, set to“USA”.
Stringmember
178
XMD ResourceAnalytics REST API Reference
XmdDerivedDimensionSalesforceActionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Indicates whether the action is enabled fora specific dimension.
Booleanenabled
36.0The name of the action.Stringname
XmdDerivedMeasureInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Format details for the Derived Measure.XmdDerivedMeasureFormatInputRepresentation
format
36.0Identifier (API name) for the dataset field.Stringfield
36.0Display name for the dataset field. Can beup to 40 characters. For example, “SalesAmount".
Stringlabel
36.0Determines whether the dataset field canbe selected from the dashboard designer
BooleanshowInExplorer
or explorer when creating dashboards andlenses. Even if showInExplorer is false, thefield can still be used for SAQL queries,manually added in JSON, and accessedusing the Analytics REST API.
XmdDerivedMeasureFormatInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0When customizing the display, you canadd a prefix, suffix, grouping separator,
StringcustomFormat
decimal separator, and leading and trailingzeros. You can also configure the numberof digits. You can include any charactersin prefixes and suffixes, including minussigns or currency symbols. You can use thefollowing symbols to specifying a format.
• 0. One digit. Use to add leading ortrailing 0s. For example, if you applycustom format #,###.00 to 56375, theresult is 56,375.00.
179
XMD ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
• #. Adds zero or one digit. Use to showdigits when applicable. For example,if you apply custom format #,###.## to56375.56, the result is 56,375.56.
• .(period). Symbol used as the decimalseparator, like in the number 375.56.Analytics currently only supports thedecimal symbol (.) as a decimalseparator.
• ,(comma). Symbol used as thegrouping separator, like in 56,375.Analytics currently only supports thecomma symbol (,) as a groupingseparator. Example: [\"-$#,###.00$\",1]
36.0The multiplier for the unit. The multiplierchanges a field’s values by the same
DoubleunitMultiplier
factor—like multiplying by 100 to convertdecimals to percents.The multiplier mustbe a positive number.
XmdDimensionMemberInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The color for the member. For example,set to “Blue”.
Stringcolor
36.0The label for the member. For example,set to “United States”.
Stringlabel
36.0The member value. For example, set to“USA”.
Stringmember
XmdDimensionSalesforceActionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Indicates whether the action is enabled fora specific dimension.
Booleanenabled
36.0The name of the action.Stringname
180
XMD ResourceAnalytics REST API Reference
XmdDimensionInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The field name of the dimension (used inqueries).
Stringfield
36.0Display name for the dataset field. Can beup to 40 characters.
Stringlabel
36.0The URL to open when the user clicks thelink in the actions menu. Overrides the
StringlinkTemplate
default URL link, whichis"/{{row.recordIdField}}". The default findsthe Salesforce record with the record IDspecified in the recordIdField XMDparameter. Must be 255 characters or less.To open a Salesforce recordfrom amulti-org environment, enter{{instanceUrl}} to populate the org URLspecified in the“organizations” section ofthe XMD. Example:"/{{row.dimensionNameId}}".
36.0Display the link to open a Salesforce recordor URL. If set to false or not set, the menu
BooleanlinkTemplateEnabled
doesn't display the Open Record linkoption.
36.0The tooltip that a dashboard viewer seeswhen they hover over the link in anAnalytics lens or dashboard.
StringlinkTooltip
36.0Customizations for specific values of thedataset fields. For example, for the
XmdDimensionMemberInputRepresentation[]
members
"Country" field, change the label of the"USA" to "United States." And change thecolor for this value in a chart to blue.
Note: When you change the label,the new label only appears in theuser interface. You can’t use thelabel in queries, like a query filter.For this, the best practice is tomodify the field values when youcreate the dataset.
36.0Ordered list of dimensions and measures.These dataset fields are used to help a
String[]recordDisplayFields
dashboard viewer identify a Salesforcerecord when multiple records match the
181
XMD ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
action. For each field, specify its API name.In some instances, a dimension value isassociated with multiple IDs and isn’tunique. For example, an opportunity withthe name “acme” has multiple opportunityIDs (and records). But the action or link canonly be directed to one record.
36.0The dataset field that contains the recordID of the Salesforce object that you wantto perform the action on.
StringrecordIdField
36.0The record organization ID for thisdimension.
StringrecordOrganizationIdField
36.0Actions that appear in the action menu.You can only add actions that are defined
XmdDimensionSalesforceAction
salesforceActions
in the page layouts for the correspondingInputRepresentation[] Salesforce object. If left blank, Analytics
shows all actions.
36.0Enables a Salesforce actions menu toappear on the field. If set to false or not set,the menu doesn't display any actions.
BooleansalesforceActionsEnabled
36.0Determines whether the dataset field canbe selected from the dashboard designer
BooleanshowInExplorer
or explorer when creating dashboards andlenses. Even if showInExplorer is false, thefield can still be used for SAQL queries,manually added in JSON, and accessedusing the Analytics REST API.
XmdMeasureInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0Format details for the Measure.XmdMeasureFormatInputRepresentation
format
36.0Identifier (API name) for the dataset field.Stringfield
36.0Display name for the dataset field. Can beup to 40 characters. For example, “SalesAmount".
Stringlabel
36.0Determines whether the dataset field canbe selected from the dashboard designer
BooleanshowInExplorer
182
XMD ResourceAnalytics REST API Reference
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
or explorer when creating dashboards andlenses. Even if showInExplorer is false, thefield can still be used for SAQL queries,manually added in JSON, and accessedusing the Analytics REST API.
XmdMeasureFormatInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
38.0When customizing the display, you canadd a prefix, suffix, grouping separator,
StringcustomFormat
decimal separator, and leading and trailingzeros. You can also configure the numberof digits. You can include any charactersin prefixes and suffixes, including minussigns or currency symbols. You can use thefollowing symbols to specifying a format.
• 0. One digit. Use to add leading ortrailing 0s. For example, if you applycustom format #,###.00 to 56375, theresult is 56,375.00.
• #. Adds zero or one digit. Use to showdigits when applicable. For example,if you apply custom format #,###.## to56375.56, the result is 56,375.56.
• .(period). Symbol used as the decimalseparator, like in the number 375.56.Analytics currently only supports thedecimal symbol (.) as a decimalseparator.
• ,(comma). Symbol used as thegrouping separator, like in 56,375.Analytics currently only supports thecomma symbol (,) as a groupingseparator. Example: [\"-$#,###.00$\",1]
36.0The multiplier for the unit. The multiplierchanges a field’s values by the same
DoubleunitMultiplier
factor—like multiplying by 100 to convertdecimals to percents.The multiplier mustbe a positive number.
183
XMD ResourceAnalytics REST API Reference
XmdOrganizationInputRepresentation
AvailableVersion
Required orOptional
DescriptionTypeProperty Name
36.0The ID of the organization.IDid
36.0URL of the Salesforce org. If a customdomain name is set up for the org, it’s thedomain name for the org.
StringinstanceUrl
36.0Display name for the Salesforce org. Canbe up to 40 characters.
Stringlabel
184
XMD ResourceAnalytics REST API Reference