# legacydeveloper Bi Dev Guide Rest - Full Documentation # Abstract Field The base definition of a dataset field. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`defaultValue`	Object	An optional default value	Small, 37.0	37.0
`description`	String	An optional description of the field	Small, 37.0	37.0
`fieldType`	ConnectWaveFieldTypeEnum	The type of the field. Valid values are: `Date` `DateOnly` `DateTime` `Numeric` `Text`	Small, 37.0	37.0
`format`	String	For date field types, the format is used to parse the input value. For other field types, the format string is used for display.	Small, 37.0	37.0
`label`	String	The label for the field.	Small, 37.0	37.0
`multiValue`	Boolean	Indicates if the field is a multivalue field (`true`) or not (`false`). The default is false.	Small, 37.0	37.0
`multiValueSeparator`	String	Required only for fields where `multiValue` is true. This is the value separator for multivalues.	Small, 37.0	37.0
`name`	String	The field developer name.	Small, 37.0	37.0
`precision`	Integer	The numeric precision or text length depending on the field type.	Small, 37.0	37.0
`scale`	Integer	The numeric scale for numeric field types only.	Small, 37.0	37.0
`systemField`	Boolean	Indicates if the field is a system field (`true`) or not (`false`). The default is false. System fields are not queryable.	Small, 37.0	37.0
`uniqueId`	Boolean	Indicates whether the field is a unique ID for the data set (`true`) or not (`false`). The default is false. There can only be one unique ID for any data set.	Small, 37.0	37.0

# Abstract Lint Item The base readiness task for an Analytics template. ## Properties Inherited by [TemplateLintItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_lint_item.htm "An individual linting task for an Analytics template.") and [TemplateReadinessItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_readiness_item.htm "An individual validation task for an Analytics template.").

Property Name	Type	Description	Filter Group and Version	Available Version
`label`	String	The label for the task.	Small, 58.0	58.0
`message`	String	The message for the task.	Small, 58.0	58.0
`readinessStatus`	TemplateReadinessStatusEnum	The status for the task. Valid values are: `Complete` `Failed` `Warning`	Small, 58.0	58.0

# Action A Salesforce action. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | apiName | String | The API name of the action. | Small, 40.0 | 40.0 | | iconUrl | String | The icon URL of the action. | Small, 40.0 | 40.0 | | label | String | The label of the action. | Small, 40.0 | 40.0 | | primaryColor | String | The primary color of the action. | Small, 40.0 | 40.0 | | subType | String | The sub type of the action. | Small, 40.0 | 40.0 | # Action Collection A collection of Salesforce actions available to the user. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | actions | [Action](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_action.htm "A Salesforce action.")\[\] | The list of Salesforce actions for the current user. | Small, 40.0 | 40.0 | #### See Also - [Actions Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_actions.htm "Returns the Salesforce actions available for the user in Analytics. The entityId is the user id.") # Action Input The action for a rule or macro to perform during a JSON transformation. Properties

Parameter Name	Type	Description	Required or Optional	Available Version
`action`	ConnectActionTypeEnum	The action types. Valid values are: `Add` - Add a value to an existing array in the JSON tree. `Delete` - Delete an attribute or node from the JSON tree. `Eval` - Evaluate an expression, usually for a macro definition. `Put` - Insert an attribute or node into the JSON tree. `Replace` - Performs a global search and replace on the entire JSON document. `Set` - Set the value of an existing attribute in the JSON tree.	Required	43.0
`condition`	String	The condition to meet for the action to be run.	Optional	43.0
`description`	String	The description of the action.	Optional	43.0
`index`	Integer	The index into an array. Use with `Add` actions.	Optional	43.0
`key`	String	The key of the action. Use with `Put` actions.	Optional	43.0
`path`	String	The JSON path to perform the action on.	Required	43.0
`value`	String	The value of the action. Use with all actions expect the `Delete` action.	Optional	43.0

# Actions Resource Returns the Salesforce actions available for the user in Analytics. The entityId is the user id. ## Resource URL /wave/actions/ ## Formats JSON ## Available Version 40.0 ## Available in Postman To view and test a working example of this resource, see [getActionCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-bb4b7379-80d5-46fc-9368-e7f15b040889?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getActions()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-actions.html) ## HTTP Methods GET ## Response body for GET [Action Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_action_collection.htm "A collection of Salesforce actions available to the user.") # Advanced Property An advanced property is a replication property for a data connector source object. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
dataType	ConnectWaveConnPropertyTypeEnum	The field type of the advanced property. Valid values are: `Boolean` `Numeric` `Text`	Small, 45.0	45.0
defaultValue	Object	The default value of the advanced property.	Small, 45.0	45.0
description	String	The description of the advanced property.	Small, 45.0	45.0
isRequired	Boolean	Indicates whether the property is required (`true`) or not (`false`).	Small, 45.0	45.0
label	String	The label of the advanced property.	Small, 45.0	45.0
name	String	The name of the advanced property.	Small, 45.0	45.0

# Advanced Property Value An advanced property name and value pair. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the advanced property. | Small, 44.0 | 44.0 | | value | String | The value of the advanced property. | Small, 44.0 | 44.0 | # Advanced Property Value Input An advanced property name and value pair. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the advanced property. | Required | 44.0 | | value | String | The value of the advanced property. | Required | 44.0 | # Analysis Configuration Outcome The outcome for an Einstein Discovery story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field | String | The field selected by the user to create a story. | Small, 55.0 | 55.0 | | goal | String | The goal selected for the story. | Small, 55.0 | 55.0 | | label | String | The label for the outcome. | Small, 55.0 | 55.0 | | predictionType | String | The type of prediction. | Small, 55.0 | 55.0 | | type | String | The type of the outcome. | Small, 55.0 | 55.0 | # Analytics App Setting A setting for an Analytics app. Properties | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | value | String | The value of the setting. | Small, 57.0 | 57.0 | # Analytics App Setting Collection The collection of Analytics app settings. Properties | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | settings | Map | The map of Analytics app settings. | Small, 57.0 | 57.0 | #### See Also - [Folder Settings Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_settings.htm "Returns or updates the settings for an Analytics app or folder with the specified ID.") # Analytics App Setting Collection Input The collection of Analytics app settings. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | settings | Map | The map of Analytics app settings. | Required | 57.0 | #### See Also - [Folder Settings Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_settings.htm "Returns or updates the settings for an Analytics app or folder with the specified ID.") # Analytics App Setting Input A setting for an Analytics app. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | value | String | The value of the setting. | Required | 57.0 | # Analytics Asset An Analytics asset. ## Properties AnalyticsAsset inherits properties from the abstract [BaseWaveAssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear in AnalyticsAsset alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`dataRefreshDate`	Date	The date when the dataset was last refreshed.	Small, 48.0	48.0
`datasetType`	ConnectWaveDatasetTypeEnum	The dataset type. Valid values are: `Default` `Live` `StagedData` `Trended`	Small, 56.0	56.0
`files`	BaseFile[]	The list of files used to create the asset. Valid values are: AnalyticsDataAssetFile LensFile	Small, 47.0	47.0
`folder`	AssetReference	The folder that the asset belongs to.	Small, 47.0	47.0
`folderType`	ConnectFolderType	The folder type field for folder assets.	Small, 53.0	53.0
`icons`	TemplateIcons	The icons for the asset.	Small, 56.0	56.0
`lastArchivedBy`	WaveUser	The user who last archived the asset.	Small, 67.0	67.0
`lastArchivedDate`	Date	The date and time when the asset was last archived.	Small, 67.0	67.0
`outcome`	AnalysisConfigurationOutcome	The analysis outcome for an Einstein Discovery asset.	Small, 55.0	55.0
`owner`	WaveUser	The owner of the asset.	Small, 55.0	55.0
`status`	String	The status for an Einstein Discovery asset.	Small, 55.0	55.0
`visibility`	ConnectWaveAssetVisibilityType	The visibility type. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Small, 51.0	51.0

#### See Also - [Analytics Asset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_asset_id.htm "Returns an Analytics asset by ID.") # Analytics Asset Collection A collection of Analytics assets. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | assets | [AnalyticsAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_asset.htm "An Analytics asset.")\[\] | The list of Analytics assets. | Small, 47.0 | 47.0 | | nextPageToken | String | The token for the next page. | Small, 47.0 | 47.0 | | totalCount | Integer | The total count of assets in the collection | Small, 47.0 | 47.0 | #### See Also - [Analytics Assets Collection Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_assets.htm "Returns a collection of Analytics assets.") # Analytics Asset Collection Query Input The query parameters used to request a collection of Analytics assets. ## Properties

Parameter Name	Type	Description	Required or Optional	Available Version
`archiveScope`	ConnectArchivedAssetScopeEnum	The scope for archived assets. Valid values are: `Active` `Archived`	Optional	67.0
`filterPlaceholderDatasets`	Boolean	Indicates whether to filter the assets with placeholder datasets from the collection (`true`) or not (`false`).	Optional	50.0
`filters`	Map<String, AnalyticsAssetFilterInput>	A map of filters to apply to the collection query.	Optional	47.0
`includeSubfolders`	Boolean	Indicates whether to include the assets in subfolders in the collection (`true`) or not (`false`).	Optional	56.0
`limit`	Integer	The limit of assets to include in the collection.	Optional	47.0
`mobileHidden`	Boolean	Indicates whether to exclude mobile assets from the collection (`true`) or not (`false`).	Optional	47.0
`nextPageToken`	String	The next page token value for the collection.	Optional	47.0
`offset`	Integer	The offset value for the collection.	Optional	47.0
`order`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `App` `CreatedBy` `CreatedById` `CreatedDate` `FolderName` `LastModified` `LastModifiedBy` `LastModifiedById` `LastModifiedDate` `Location` `Mru` (Most Recently Used, last viewed date) `Name` `Outcome` `Owner` `RefreshDate` (for assets like datasets) `RunDate` (for assets like reports) `Status` `Title` `Type`	Optional	52.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `Browse` `CreatedByMe` `InsightsApplicationsIsCansEdit` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`searchTerm`	String	The search term to use for assets in the collection.	Optional	47.0
`sortDirection`	ConnectWaveSortOrderEnum	The ordering applied to the collection results. Valid values are: `Ascending` `Descending`	Optional	52.0
`useAutoSuggestions`	Boolean	Indicates whether to use automated suggestions to populate the collection (`true`) or not (`false`).	Optional	48.0

#### See Also - [Analytics Assets Collection Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_assets.htm "Returns a collection of Analytics assets.") # Analytics Asset Filter Input A filter for the Analtyics asset collection parameters. ## Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | operator | String | The filter operation value. | Optional | 47.0 | | value | String\[\] | A list of filter values. | Optional | 47.0 | # Analytics Asset Resource Returns an Analytics asset by ID. ## Resource URL /analytics/assets/query/ ## Formats JSON ## Available Version 55.0 ## HTTP Methods GET ## Response body for GET [Analytics Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_asset.htm "An Analytics asset.") # Analytics Assets Collection Resource Returns a collection of Analytics assets. ## Resource URL /analytics/assets/query ## Formats JSON ## Available Version 55.0 ## HTTP Methods POST ## Request body for POST [Analytics Asset Collection Query Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_analytics_asset_collection_query_input.htm "The query parameters used to request a collection of Analytics assets.") ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note The request body can be empty JSON if no query parameters are needed. ## Response body for POST [Analytics Asset Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_asset_collection.htm "A collection of Analytics assets.") # Analytics Assets Resources Query Analytics assets using parameters for a collections or query a single asset by ID. ## Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Analytics Assets Collection Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_assets.htm "Returns a collection of Analytics assets.") | Returns a collection of Analytics assets specified by the input parameters. | POST | /analytics/assets/query | | [Analytics Asset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_asset_id.htm "Returns an Analytics asset by ID.") | Returns an Analytics asset. | GET | /analytics/assets/query/ | | [Asset Archival Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_assets_archive.htm "Archives or restores one or more CRM Analytics assets by moving them to or from the Recycle Bin.") | Archives or restores one or more CRM Analytics assets by moving them to or from the Recycle Bin. | POST | /analytics/assets/archive | - **[Analytics Assets Collection Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_assets.htm)** Returns a collection of Analytics assets. - **[Analytics Asset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_asset_id.htm)** Returns an Analytics asset by ID. - **[Asset Archival Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_assets_archive.htm)** Archives or restores one or more CRM Analytics assets by moving them to or from the Recycle Bin. # Analytics Data Asset File A file used for preview of an Analytics data asset. Inherits properties from [Base File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_file.htm "The base Analytics file."). #### See Also - [Asset Files List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_assetfiles_id_files.htm "Returns a collection of asset files for an asset and creates an asset file.") - [Asset File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_assetfiles_id_files_id.htm "Returns a preview file for an asset and updates the file.") # Analytics REST API Appendices Use these appendices when working with enums and other shared resources. - **[Analytics REST API Enums](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_dev_guide_rest_enums.htm)** Enums specific to the /wave namespace - **[Analytics REST API Appendix](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm)** This appendix contains the references for shared representations and enums that are used across the Analytics REST API resources. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API request and response bodies. - **[Dashboard State Representation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboard_state_rep.htm)** This page contains the reference for the DashboardStateRepresentation resource and all the representations that make up the dashboard state for API responses. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API response bodies. - **[Dashboard State Input Representation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboard_state_input_rep.htm)** This page contains the reference for the DashboardStateInputRepresentation resource and all the representations that make up the dashboard state for API POST and PATCH requests. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API request bodies. # Analytics REST API Appendix This appendix contains the references for shared representations and enums that are used across the Analytics REST API resources. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API request and response bodies. ## AbstractFieldRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`defaultValue`	Object	An optional default value	Small, 37.0	37.0
`description`	String	An optional description of the field	Small, 37.0	37.0
`fieldType`	ConnectWaveFieldTypeEnum	The type of the field. Valid values are: `Date` `DateOnly` `DateTime` `Numeric` `Text`	Small, 37.0	37.0
`format`	String	For date field types, the format is used to parse the input value. For other field types, the format string is used for display.	Small, 37.0	37.0
`label`	String	The label for the field.	Small, 37.0	37.0
`multiValue`	Boolean	Indicates if the field is a multivalue field (`true`) or not (`false`). The default is false.	Small, 37.0	37.0
`multiValueSeparator`	String	Required only for fields where `multiValue` is true. This is the value separator for multivalues.	Small, 37.0	37.0
`name`	String	The field developer name.	Small, 37.0	37.0
`precision`	Integer	The numeric precision or text length depending on the field type.	Small, 37.0	37.0
`scale`	Integer	The numeric scale for numeric field types only.	Small, 37.0	37.0
`systemField`	Boolean	Indicates if the field is a system field (`true`) or not (`false`). The default is false. System fields are not queryable.	Small, 37.0	37.0
`uniqueId`	Boolean	Indicates whether the field is a unique ID for the data set (`true`) or not (`false`). The default is false. There can only be one unique ID for any data set.	Small, 37.0	37.0

## AdvancedPropertyValueRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the advanced property. | Small, 44.0 | 44.0 | | value | String | The value of the advanced property. | Small, 44.0 | 44.0 | ## AssetReferenceRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The 18 character ID of the asset. | Small, 36.0 | 36.0 | | label | String | The asset label. | Small, 36.0 | 36.0 | | name | String | The asset developer name. | Small, 36.0 | 36.0 | | namespace | String | The namespace that qualifies the asset name. The default is the current organization's namespace, which is "empty namespace" for all organizations, except those developer edition orgs that have set a namespace. | Small, 37.0 | 37.0 | | url | String | The asset URL. | Small, 36.0 | 36.0 | ## AssetReferenceInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | id | String | The 18 character ID of the asset. | Optional (Id or Name must be provided) | 36.0 | | name | String | The asset developer name. | Optional (Id or Name must be provided) | 36.0 | | namespace | String | The namespace that qualifies the asset name. The default is the current organization's namespace, which is "empty namespace" for all organizations, except those developer edition orgs that have set a namespace. | Only required in orgs with namespace defined | 37.0 | ## AssetRevertHistoryInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | historyId | String | The required source history id for this asset to revert to. | Required | 42.0 | | historyLabel | String | The history label to tag the revert change with. | Optional | 42.0 | ## BaseAssetInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | description | String | Short description of the asset | Required for POST; Optional in PATCH | 36.0 | | name | String | The asset developer name. | Required for POST; Not allowed to edit in PATCH | 36.0 | | label | String | The asset label. | Optional in POST and PATCH | 37.0 | ## BaseWaveAssetRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`assetSharingUrl`	String	The URL for opening this asset in the user interface. This is a form of deep linking. The server examines the link parameters, which can include urlType, assetId, orgId, and loginHost, as well as other optional parameters, and translates as necessary to produce the correct result on the target client. For example, it opens the asset on a desktop client, or mobile if you are on a mobile OS.	Small, 36.0	36.0
`createdBy`	WaveUserRepresentation	The user who created the asset.	Small, 36.0	36.0
`createdDate`	Date	The time at which the asset was created, in ISO8601 date format.	Small, 36.0	36.0
`description`	String	Short description of the asset.	Small, 36.0	36.0
`id`	String	The 18 character ID of the asset.	Small, 36.0	36.0
`label`	String	The asset label.	Small, 36.0	36.0
`lastAccessedDate`	Date	The last time the asset was accessed, in ISO8601 date format.	Small, 36.0	36.0
`lastModifiedBy`	WaveUserRepresentation	The user who last updated the asset.	Small, 36.0	36.0
`lastModifiedDate`	Date	The last time the asset was modified, in ISO8601 date format.	Small, 36.0	36.0
`name`	String	The asset developer name.	Small, 36.0	36.0
`namespace`	String	The namespace that qualifies the asset name. The default is the current organization's namespace, which is "empty namespace" for all organizations, except those developer edition orgs that have set a namespace.	Small, 36.0	36.0
`permissions`	PermissionsRepresentation	The permissions for the current user.	Small, 36.0	36.0
`type`	ConnectWaveAssetTypeEnum	The asset type. The default type is Dashboard. Valid types are: `Collection` `Component` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `Widget` `Workflow`	Optional, Small, 36.0	36.0
`url`	String	The asset URL.	Small, 36.0	36.0

## TypedAssetReferenceRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | type | [ConnectWaveAssetTypeEnum](#ConnectWaveAssetTypeEnum_values) | The type of the asset. | Small, 51.0 | 51.0 | ## TypedAssetReferenceInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | type | [ConnectWaveAssetTypeEnum](#ConnectWaveAssetTypeEnum_values) | The type of the asset. | Required | 51.0 | ## WaveUserRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The 18-character user ID. | Small, 36.0 | 36.0 | | name | String | The name of the user. | Small, 36.0 | 36.0 | | profilePhotoUrl | String | The Chatter profile photo of the user. | Small, 36.0 | 36.0 | ## PermissionsRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | create | Boolean | Indicates whether the user can create an asset (true) or not (false). | Small, 45.0 | 45.0 | | manage | Boolean | Indicates whether the user can manage access on the asset (true) or not (false). | Small, 36.0 | 36.0 | | modify | Boolean | Indicates whether the user can modify the asset (true) or not (false). | Small, 36.0 | 36.0 | | view | Boolean | Indicates whether the user can view the asset (true) or not (false). | Small, 36.0 | 36.0 | ## ScheduleRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`assetId`	String	The asset ID that this schedule belongs to.	Small, 52.0	52.0
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`nextScheduledDate`	Date	Next scheduled time (in UTC) for this schedule	Small, 43.0	43.0
`notificationLevel`	ConnectEmailNotificationLevelEnum	Email notification level of dataflow associated with this schedule. Valid values are: `Always` `Failures` `Never` `Warnings`	Small, 43.0	43.0
`time`	TimeRepresentation	Hour,minute, and timezone in which this schedule is run	Small 39.0	39.0

## DailyScheduleRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`time`	TimeRepresentation	Hour, minute, and timezone in which this schedule is run.	Small, 39.0	39.0

## EventDrivenScheduleRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | triggerRule | String | The event based trigger rule that causes the asset to run. | Small, 53.0 | 53.0 | ## HourlyScheduleRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 40.0	40.0
`hourlyInterval`	Integer	Number of hours between each queuing of the task.	Small, 40.0	40.0
`lastHour`	Integer	Last hour at which this task stops queuing.	Small, 40.0	40.0

## MonthlyRelativeScheduleRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`time`	TimeRepresentation	Hour, minute, and timezone in which this schedule is run.	Small, 39.0	39.0
`dayInWeek`	ConnectWaveDayOfWeekEnum	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 39.0	39.0
`weekInMonth`	ConnectWaveRelativeWeekEnum	Week within a month. Values values are: `First` `Second` `Third` `Fourth` `Last`	Small, 39.0	39.0

## MonthlySpecificScheduleRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`time`	TimeRepresentation	Hour and timezone in which this schedule is run.	Small, 39.0	39.0
`daysOfMonth`	Integer[]	Days of the month on which the schedule runs (-1, 1–31). Months lacking specific days will skip the job. Can specify a single value of -1 to indicate the last day of the month (-1 cannot be used with other days).	Small, 39.0	39.0

## WeeklyScheduleRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`time`	TimeRepresentation	Hour and timezone in which this schedule is run.	Small, 39.0	39.0
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 39.0	39.0

## TimeRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | hour | Integer | Hour at which this schedule is run (0-23). | Small, 39.0 | 39.0 | | minute | Integer | Minute at which this schedule is run (0-59). | Small, 39.0 | 39.0 | | timeZone | [TimeZoneRepresentation](#TimeZoneRepresentation) | Time zone of the hour at which the schedule is run. | Small, 39.0 | 39.0 | ## TimeZoneRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | gmtOffset | Double | The signed offset, in hours, from GMT. | Small, 39.0 | 39.0 | | name | String | The display name of this time zone. | Small, 39.0 | 39.0 | | zoneId | String | The id of this time zone. | Small, 39.0 | 39.0 | ## ScheduleInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Required	39.0
`notificationLevel`	ConnectEmailNotificationLevelEnum	Level of email notification for the scheduled job. Valid values are: `Always` `Warnings` `Failures` `Never`	Optional	42.0
`time`	TimeInputRepresentation	The time when the schedule runs.	Required	39.0

## DailyScheduleInputRepresentation Inherits frequency, notification, and time from [ScheduleInputRepresentation](#ScheduleInputRepresentation) ## EventBasedScheduleInputRepresentation Inherits frequency, notification, and time from [ScheduleInputRepresentation](#ScheduleInputRepresentation) | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | triggerRule | String | The expression defining the events that trigger the schedule of the target asset. Currently accepts scheduling of Dataflows and Recipes as the target. | Required | 53.0 | ## HourlyScheduleInputRepresentation Inherits frequency, notification, and time from [ScheduleInputRepresentation](#ScheduleInputRepresentation)

Property Name	Type	Description	Required or Optional	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Required	39.0
`hourlyInterval`	Integer	Number of hours in between queuing or scheduling of an asset.	Required	39.0
`lastHour`	Integer	Hour of day at which the schedule stops queuing the asset for processing.	Required	39.0

## MonthlyRelativeScheduleInputRepresentation Inherits frequency, notification, and time from [ScheduleInputRepresentation](#ScheduleInputRepresentation)

Property Name	Type	Description	Required or Optional	Available Version
`dayInWeek`	ConnectWaveDayOfWeekEnum	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 39.0	39.0
`weekInMonth`	ConnectWaveRelativeWeekEnum	Week within a month. Values values are: `First` `Second` `Third` `Fourth` `Last`	Small, 39.0	39.0

## MonthlySpecificScheduleInputRepresentation Inherits frequency, notification, and time from [ScheduleInputRepresentation](#ScheduleInputRepresentation) | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | daysOfMonth | Integer\[\] | Days of the month on which the schedule runs (1-31). Months lacking specific days will skip the job. | Required | 39.0 | ## WeeklyScheduleInputRepresentation Inherits frequency, notification, and time from [ScheduleInputRepresentation](#ScheduleInputRepresentation)

Property Name	Type	Description	Required or Optional	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Required	39.0

## TimeInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | hour | Integer | First hour in the day on which the schedule is run. | Required | 39.0 | | minute | Integer | Minute offset from hour on which the schedule is first run. | Required | 39.0 | | timeZone | String | The time zone the schedule is stored in, which by default, is the user's time zone. | Required | 39.0 | ## Common Enums ConnectAnalyticsLicenseTypeEnum

Property Name	Type	Description	Required or Optional	Available Version
`licenseType`	ConnectAnalyticsLicenseTypeEnum	The Analytics license types. Valid values are: `EinsteinAnalytics` (Analytics) `Sonic` (Salesforce Data Pipeline)	Optional	51.0

ConnectAnalyticsLimitTypeEnum

Property Name	Type	Description	Required or Optional	Available Version
`types`	ConnectAnalyticsLimitTypeEnum	The types of limits used in Analytics. Valid values are: `BatchTransformationHours` (Maximum dataflow runtime per month) `DatasetQueries` (Maximum queries on datasets for all users) `DatasetRowCount` (Maximum row of all datasets combined) `MaxDailyRowsHighOutputCon` (Maximum rows for all high volume tier output connectors per rolling 24-hour period) `MaxDailyRowsLowOutputCon` (Maximum rows for all low volume tier output connectors per rolling 24-hour period) `MaxDailyRowsMedOutputCon` (Maximum rows for all medium volume tier output connectors per rolling 24-hour period) `MaxDailySizeHighOutputCon` (Maximum data size for all high volume tier output connectors per rolling 24-hour period) `MaxDailySizeLowOutputCon` (Maximum data size for all low volume tier output connectors per rolling 24-hour period) `MaxDailySizeMedOutputCon` (Maximum data size for all medium volume tier output connectors per rolling 24-hour period) `OutputLocalConnectorVolume` (Maximum cumulative bytes of data files written to Salesforce in a rolling 24-hour period)	Optional	51.0

ConnectWaveAssetTypeEnum

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	ConnectWaveAssetTypeEnum	The asset type. The default type is Dashboard. Valid types are: `Collection` `Component` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `Widget` `Workflow`	Optional, Small, 36.0	36.0

ConnectWaveAssetVisibilityType

Property Name	Type	Description	Filter Group and Version	Available Version
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Small, 51.0	51.0

ConnectWaveScopeTypeEnum

Property Name	Type	Description	Required or Optional	Available Version
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `CreatedByMe` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0

ConnectWaveDatasetSortOrderTypeEnum

Property Name	Type	Description	Required or Optional	Available Version
`sort`	ConnectWaveDatasetSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `CreatedBy` `CreatedDate` `LastModified` `LastQueried` `LastRefreshed` `Mru` (Most Recently Used, last viewed date) `Name` `TotalRows`	Optional	38.0

ConnectWaveSortOrderTypeEnum

Property Name	Type	Description	Required or Optional	Available Version
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `App` `CreatedBy` `CreatedDate` `LastModified` `LastModifiedBy` `Mru` (Most Recently Used, last viewed date) `Name` `Type`	Optional	38.0

ConnectWaveScheduleFrequencyTypeEnum

Property Name	Type	Description	Required or Optional	Available Version
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Required	39.0

ConnectWaveRelativeWeekEnum

Property Name	Type	Description	Filter Group and Version	Available Version
`weekInMonth`	ConnectWaveRelativeWeekEnum	Week within a month. Values values are: `First` `Second` `Third` `Fourth` `Last`	Small, 39.0	39.0

ConnectWaveDayOfWeekEnum

Property Name	Type	Description	Filter Group and Version	Available Version
`dayInWeek`	ConnectWaveDayOfWeekEnum	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 39.0	39.0

ConnectEmailNotificationLevelEnum

Property Name	Type	Description	Filter Group and Version	Available Version
`emailNotificationLevel`	ConnectEmailNotificationLevelEnum	Valid types of email notification levels you can set. Valid values are: `Always` `Failures` `Never` `Warnings`	Small, 42.0	42.0

# Analytics REST API Enums Enums specific to the /wave namespace Enums are not versioned. Enum Values are returned in all API versions. Clients should handle values they don't understand gracefully.

Enum	Description
AutoInstallRequestFailedReasonEnum	The reason that the auto-install request failed, where applicable. Valid values are: `AppConstructionFailure` `AppCreateFailure` `AppInstallationSkipped` `AppUpdateFailure` `CancelFailed` `DeleteFailed` `DependencyCancelled` `DependencyFailure` `FailedOther` `FailedToEnqueue` `OrganizationIncompatible` `RequestCancelled` `RetriesExhausted` `WaveDisabled`
AutoInstallRequestSearchOptionEnum	Filters the results to include only the contents with specific search options. Valid values include: `ExcludeNonExistingApps` `MostRecentOnlyByTemplateAndFolder` `NonExistingAppsOnly`
AutoInstallRequestSortOptionEnum	Sorts the results according to the given sort option. Valid values include: `CreatedDateAscending` `CreatedDateDescending` `FolderIdAscending` `FolderIdDescending` `FolderLabelAscending` `FolderLabelDescending` `LastModifiedDateAscending` `LastModifiedDateDescending` `RequestNameAscending` `RequestNameDescending` `RequestStatusAscending` `RequestStatusDescending` `RequestTypeAscending` `RequestTypeDescending` `TemplateApiNameAscending` `TemplateApiNameDescending`
AutoInstallRequestStatusEnum	The auto-install request status. Valid values include: `AppInProgress` `Cancelled` `Enqueued` `Failed` `InProgress` `New` `Skipped` `Success`
AutoInstallRequestTypeEnum	The type of the auto-install request. Valid values include: `OrgCompatibilityCheck` `StartDataflow` `WaveAppAutoUpdate` `WaveAppCreate` `WaveAppDelete` `WaveAppUpdate` `WaveEnable`
CollectionCreatedByTypeEnum	The type of user who created the pin. Valid values are: `Admin` `None` `User`
CollectionTypeEnum	The collection type. Valid values are: `Static`
ConnectWaveAccessTypeEnum	The access type. Valid values are: `Edit` `Manage` `View`
CollectionItemAssetTypeEnum	Filters the results by the collection item asset type. Valid values are: `Component` `Dashboard` `DashboardSavedView` `Lens` `LightningDashboard` `Report` `TableauDashboard` `TableauWorkbook`
CollectionPinTypeEnum	The type of pinning. Valid values are: `All` `Desktop` `Mobile` `None`
ConnectAnalyticsLicenseTypeEnum	The Analytics license types. Valid values are: `Cdp` (Data 360) `DataPipelineQuery` (Data Pipeline Query) `EinsteinAnalytics` (CRM Analytics) `IntelligentApps` (Intelligent Apps) `Sonic` (Salesforce Data Pipeline)
ConnectAnalyticsLimitTypeEnum	The types of limits used in Analytics. Valid values are: `BatchTransformationHours` (Maximum dataflow runtime per month) `DatasetQueries` (Maximum queries on datasets for all users) `DatasetRowCount` (Maximum row of all datasets combined) `MaxDailyRowsDataCloudOutputCon` (Maximum rows for Data 360 output per rolling 24-hour period) `MaxDailyRowsHighOutputCon` (Maximum rows for all high volume tier output connectors per rolling 24-hour period) `MaxDailyRowsLowOutputCon` (Maximum rows for all low volume tier output connectors per rolling 24-hour period) `MaxDailyRowsMedOutputCon` (Maximum rows for all medium volume tier output connectors per rolling 24-hour period) `MaxDailySizeHighOutputCon` (Maximum data size for all high volume tier output connectors per rolling 24-hour period) `MaxDailySizeLowOutputCon` (Maximum data size for all low volume tier output connectors per rolling 24-hour period) `MaxDailySizeMedOutputCon` (Maximum data size for all medium volume tier output connectors per rolling 24-hour period) `MaxDailySizeVirtualPrivateCloudCon` (Maximum cumulative bytes of data sent through connections using a virtual private cloud in a rolling 24-hour period) `MaxDailyUploadVolume` (Maximum cumulative bytes of data files uploaded to Salesforce in a rolling 24-hour period) `MaxDailyWorkflowExecutions` (Maximum number of dataflow and recipe runs in a rolling 24-hour period) `MaxRecipeOutRowsPerMonth` (Maximum number of rows output by all recipes to all datasets in a month) `MaxReplicatedObjects` (Maximum number of connected objects) `OutputLocalConnectorVolume` (Maximum cumulative bytes of data files written to Salesforce in a rolling 24-hour period) `StagedDatasetRowCount` (Maximum rows for staged datasets)
`ConnectDashboardSnapshotDriftState`	The drift state of the watchlist item. Valid values are: `Clean` (Indicates the snapshot is clean) `Dirty` (Indicates the snapshot has drifted and is dirty) `IgnoreQueryDrift` (Indicates the snapshot is dirty, but user has ignored it)
ConnectDashboardSnapshotItemLastRunStatusEnum	The status of the dashboard snapshot item run. Valid values are: `DashboardBundleFailedToLoad` `FailedToParseValue` `FailedToPersistData` `GenericException` `QueryExecutionFailed` `Success`
ConnectEclairMapProjectionTypeEnum	The map projection. Valid values are: `AlbersUSA` `Equirectangular` `Mercator`
ConnectEmailNotificationLevelEnum	Valid types of email notification levels you can set. Valid values are: `Always` `Failures` `Never` `Warnings`
ConnectJobTypeEnum	The type of job. Valid values are: `DataCloudRecipe` `DataSync` `FileUpload` `Internal` `Orchestrated` `Recipe` `Recipe_V3` `Report` `Restore` `User`
ConnectScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `Weekly` (Run on one or more days each week)
ConnectSubscriptionSourceTypeEnum	The type of subscription notification. Valid values are: `Collection` `Dashboard` `Widget`
ConnectWaveApplicationStatusEnum	The creation status of application. Valid values are: `CancelledStatus` `CompletedStatus` `DataflowInProgressStatus` `ExtensionAssetTypeInProgressStatus` `FailedStatus` `InProgressStatus` `NewStatus`
ConnectWaveAssetTypeEnum	The asset type. The default type is Dashboard. Valid types are: `Collection` `Component` `ContextualDashboard` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataCloudReport` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `TableauDashboard` `TableauWorkbook` `Template` `Widget` `Workflow`
ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)
ConnectWaveBorderEdgeTypeEnum	The edges of the border to be drawn. Valid values are: All Bottom Left Right Top
ConnectWaveCompactFormCogroupTypeEnum	The compact form source cogroup type. Valid values are: Anti Inner Left Outer Right Semi
ConnectWaveCompactFormJoinTypeEnum	The compact form join type. Valid values are: Inner Left Outer Right
ConnectWaveConditionalFormattingTypeEnum	The conditional formatting type. Valid values are: `Categories` `Gradient` `Multiple` `Raw` `Single` `Static`
ConnectWaveConnectionModeEnum	The connection mode for data sync. For faster extracts, use `Incremental` or `PeriodicFull`. Valid values are: `Full` `Incremental` `PeriodicFull`
ConnectWaveDashboardSavedViewType	The type of saved view. `Shared` `User`
ConnectWaveDashboardSavedViewDatasetStateType	The type of dataset state. Valid values are: `Global`
ConnectWaveDataConnectorBundleEnum	The bundle type that the data connector belongs to. Valid values are: `AmazonRedshift` `AmazonS3` `Azure` `Cdp` `Salesforce` `Snowflake` `Tableau`
ConnectWaveConnectorCategoryEnum	The categories that the data connector belongs to. Valid values are: `AdvancedPropertiesSupport` `BatchRead` `Direct` `FileBased` `FilterSupport` `Output` `Private`
ConnectWaveDashboardStepTypeEnum	The type of dashboard step. Valid values are: Aggregate AggregateFlex Apex Cdp DirectReport Discovery Forecasting Grain Hierarchy Lens Multi Saql Soql Sql Static StaticFlex Watchlist
ConnectWaveDataConnectorHandlerEnum	The connector handler associated with the Analytics connector. Valid values are: `Base` `Infa` `Legacy`
ConnectWaveDataConnectorTypeEnum	The type of Analytics connector. The valid values are: `AmazonAthena` `AmazonRedshiftOutput` `AmazonS3` `AmazonS3Output` `AmazonS3Private` `AwsRdsAuroraMySQL` `AwsRdsAuroraPostgres` `AwsRdsMariaDB` `AwsRdsMySQL` `AwsRdsPostgres` `AwsRdsPostgresPrivate` `AwsRdsSqlServer` `AzureDataLakeGen2Output` `AzureSqlDatabase` `AzureSqlDatawarehouse` `Databricks (Beta)` `GoogleAnalytics4` `GoogleBigQuery` `GoogleBigQueryDirect` `GoogleBigQueryStandardSQL` `GoogleSpanner` `HerokuPostgres` `HubSpot` `MarketoV2` `NetSuite` `OracleEloqua` `Redshift` `RedshiftPrivate` `SalesforceExternal` `SalesforceMarketingCloudOAuth2` `SapHanaCloud` `SfdcLocal` `SnowflakeComputing` `SnowflakeDirect` `SnowflakeOutput` `SnowflakePrivate` `SnowflakePrivateOutput` `TableauOnline` `TableauHyperOutput` `Zendesk`
ConnectWaveDataflowJobStatusEnum	The status of the dataflow job. Valid values are: `Cancelled` `Failure` `Preprocessing` `Queued` `Running` `Success` `Warning`
ConnectWaveDatasetTypeEnum	The type of the dataset. Valid values are: `Default` `Live` `StagedData` `Trended`
ConnectWaveDataSourceTypeEnum	The type of datasource. Valid values are: `Apex` `Cdp` `Dataset` `Hierarchy` `ReportType` `Saql` `Sobject` `Static`
ConnectWaveDateType	The Date type. Valid values are: `Date` `DateOnly` `DateTime`
ConnectWaveHorizontalAlignmentEnum	The horizontal alignment types. Valid values are: `Center` `Left` `Right`
ConnectWaveImageFitTypeEnum	The image alignment types. Valid values are: `FitHeight` `FitWidth` `Original` `Stretch` `Tile`
ConnectWaveInputWidgetDisplayFormatEnum	The display format of the input value. Valid values are: `Currency` `None` `Percent`
ConnectWaveInputWidgetInputTypeEnum	The input type of the widget. Valid values are: `Slider` `Typein`
ConnectWaveInputWidgetValueFormatEnum	The value type of the step. Valid values are: `Date` `Number` `Text`
ConnectWaveInteractionActionTypeEnum	The action type for the interaction. Valid values are: `Clear` `Flow` `Navigate` `Reset` `Sort`
ConnectWaveInteractionClearTypeEnum	The type for the clear interaction. Valid values are: `ClearAll` `ClearExclude` `ClearInclude`
ConnectWaveInteractionDestinationTypeEnum	The destination type for the interaction. Valid values are: `Component` `Dashboard` `Explore` `Lens` `Page` `Url`
ConnectWaveInteractionEventTypeEnum	The event type for the interaction. Valid values are: `Click` `Select`
ConnectWaveInteractionResetTypeEnum	The reset type for the interaction. Valid values are: `ResetFilters`
ConnectWaveLanguageEnum	The language in which this Xmd is localized. Valid values are: `bg`: Bulgarian `zh_CN`: Chinese Simplified `zh_TW`: Chinese Traditional `hr`: Croatian `cs`: Czech `da`: Danish `nl_NL`: Dutch `en`: English `en_GB`: English (United Kingdom) `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 `ru`: Russian `sk`: Slovak `sl`: Slovenian `es`: Spanish `es_MX`: Spanish (Mexico) `sv`: Swedish `th`: Thai `tr`: Turkish `uk`: Ukrainian `vi`: Vietnamese
ConnectWaveSelectModeEnum	The select mode types. Valid values are: Multi MultiRequired None Single SingleRequired
ConnectWaveVerticalAlignmentEnum	The vertical alignment types. Valid values are: `Bottom` `Center` `Top`
ConnectWaveVisualizationTypeEnum	The visualization type for a lens. Valid values are: `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gantt` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`
ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)
ConnectWaveDayOfWeekEnum	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`
ConnectWaveSelectorDisplayModeEnum	The display mode type. Valid values are: `Combo` `Filter`
ConnectWaveRelativeWeekEnum	Week within a month. Values values are: `First` `Second` `Third` `Fourth` `Last`
ConnectWaveShareTypeEnum	The share type. Valid values are: `AllCspUsers` `AllPrmUsers` `CustomerPortalUser` `Group` `Organization` `PartnerUser` `PortalRole` `PortalRoleAndSubordinates` `Role` `RoleAndSubordinates` `RoleAndSubordinatesInternal` `User`
ConnectWaveTemplateAppActionEnum	The last template action performed on the templated application. Valid values are: `AutoUpgrade` `Create` `DecoupleApp` `Overlay` `RefreshData` `Upgrade`
ConnectWaveTemplateTypeEnum	The template type. Valid values are: `App` `Dashboard` `Data` `Embedded` `Lens`
ConnectWaveTemplateVisibilityOptionsEnum	The template visibility options. Valid values are: `CreateApp` `ManageableOnly` `OrgCanViewOnly` `ViewOnly`
ConnectWaveTextOverflowEnum	The overflow of the text. Valid values are: `Truncate` `Wrap`
ConnectWaveWidgetTypeEnum	The type of widget. Values are: `Box` `Chart` `CompareTable` `Component"` `Container` `DateSelector` `FilterPanel` `GlobalFilters` `Image` `Inherit` `Input` `Link` `ListSelector` `Navigation` `Number` `PillBox` `RangeSelector` `Repeater` `Table` `Text` `Url` `ValuesTable`
ConnectWaveXmdTypeEnum	The type of Xmd. Values are: `asset` `main` `system` `user`
CustomFilterPresetTypeEnum	The custom preset filter types. Valid values are: `AllTime` `CurrentFiscalQuarter` `CurrentFiscalQuarterToDate` `CurrentFiscalYear` `CurrentFiscalYearToDate` `CurrentMonth` `CurrentMonthToDate` `CurrentQuarter` `CurrentQuarterToDate` `CurrentWeek` `CurrentYear` `CurrentYearToDate` `Last180Days` `Last30Days` `Last7Days` `Last90Days` `Next180Days` `Next30Days` `Next7Days` `Next90Days` `NextFiscalQuarter` `NextFiscalYear` `NextMonth` `NextQuarter` `NextWeek` `NextYear` `PreviousFiscalQuarter` `PreviousFiscalQuarterToDate` `PreviousFiscalYear` `PreviousFiscalYearToDate` `PreviousFiscalMonth` `PreviousFiscalMonthToDate` `PreviousQuarter` `PreviousQuarterToDate` `PreviousWeek` `PreviousYear` `PreviousYearToDate`
DataPlatformAuditTypeEnum	The type of audit event. Valid values are: `JobCancelled` (Job was canceled by a user) `JobRunEventBased` (Job was run on an event-based schedule) `JobRunManual` (Job was run manually) `JobRunTimeBased` (Job was run on an time-based schedule) `JobScheduleModified` (Job schedule was modified) `JobScheduled` (Job was scheduled) `JobUnscheduled` (Job was unscheduled)
DatasetDmoMappingAppStatusEnum	The app status the mappings are associated with. Values are: `Idle` `InProgress` `Undefined`
Map<Object,Object>	The map of dynamic options for Analytics apps. Valid options are: `productionType`: valid values include `ATF_3_0` `Classic` `runtimeLogEntryLevel`: valid values include `Fine` `Finer` `Finest` `Info` `Severe` `Warning`
HierarchyTypeEnum	The type of hierarchy used to facet. Valid values are: `ForecastHierarchy` `RoleHierarchy`
LayoutTypeEnum	The layout type. Valid values are: `Component` `SingleColumn` `TwoColumn`
NotificationActionType	The notification action type. Valid values are: `PostToSlack` `SendEmail`
NumberTypeFormatEnum	The format for a template variable number type. Valid values are: `Currency` `Decimal` `Percent` `PercentFixed`
PageTypeEnum	The template wizard page type. Values are: `Configuration` `Validation`
PanelItemTypeEnum	The template wizard panel item type. Valid values are: `GroupBox` `Image` `LinkBox` `Text` `Variable`
RecipeDataType	The recipe data type. Valid values are: `DateOnly` `DateTime` `Multivalue` `Number` `Text`
SubscriptionScheduleDayOfWeek	The days of the week for schedule frequency. Valid values are: `Fri` `Mon` `Sat` `Sun` `Thu` `Tue` `Wed`
TooltipModeEnum	The tooltip mode. Valid values are: `Custom` `Default` `None`
TemplateReadinessStatusEnum	The status of the readiness task. Valid values are: `Complete` `Failed` `Warning`
VariableTypeEnum	The type of the template variable. Valid values are: `ArrayType` `BooleanType` `CalculatedInsightFieldType` `CalculatedInsightType` `ConnectorType` `DataLakeObjectFieldType` `DataLakeObjectType` `DataModelObjectFieldType` `DataModelObjectType` `DatasetAnyFieldType` `DatasetDateType` `DatasetDimensionType` `DatasetMeasureType` `DatasetType` `DateTimeType` `NumberType` `ObjectType` `SobjectFieldType` `SobjectType` `StringType`

Property Name	Enum	Description	Required or Optional	Available Version
`sort`	ConnectWaveDatasetSortOrderTypeEnum	The type of sort order to be applied to the returned dataset collection. Valid values are: `ConnectionName` (only valid if the dataset is a Live Dataset) `CreatedBy` `CreatedDate` `LastArchivedBy` `LastArchivedDate` `LastModified` `LastQueried` `LastRefreshed` `Mru` (Most Recently Used, last viewed date) `Name` `TotalRows`	Optional	38.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `Browse` `CreatedByMe` `InsightsApplicationsIsCansEdit` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `App` `CreatedBy` `CreatedById` `CreatedDate` `FolderName` `LastModified` `LastModifiedBy` `LastModifiedById` `LastModifiedDate` `Location` `Mru` (Most Recently Used, last viewed date) `Name` `Outcome` `Owner` `RefreshDate` (for assets like datasets) `RunDate` (for assets like reports) `Status` `Title` `Type`	Optional	38.0
`templateFilters`	ConnectWaveTemplateSearchFiltersEnum	The filter templates to apply to the returned collection. Valid values are: `AppsConstructedByTemplate` `AppsWithInstallHistory`	Optional	57.0

# Annotation An Analytics annotation. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | anchor | String | The anchor key. | Small, 37.0 | 37.0 | | asset | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The referenced asset. | Small, 37.0 | 37.0 | | feedElement | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The referenced feed element. | Small, 37.0 | 37.0 | | id | String | The 18 character annotation ID. | Small, 37.0 | 37.0 | | resolved | Boolean | Indicates whether the state of the annotation is resolved or not. | Small, 37.0 | 37.0 | | url | String | The URL to get this annotation. | Small, 37.0 | 37.0 | #### See Also - [Annotations List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations.htm "Returns a list of annotations and creates an annotation.") - [Annotation Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations_id.htm "Returns an asset's annotations and updates an annotation.") # Annotation Collection A collection of annotations. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | annotations | [Annotation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_annotation.htm "An Analytics annotation.")\[\] | The list of annotations for this asset and feedSubject. | Small, 37.0 | 37.0 | | feedSubject | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The feed subject for all annotations. | Small, 37.0 | 37.0 | | subscriptionId | String | The 18-character ID of the subscription. | Small, 38.0 | 38.0 | | url | String | The URL to get this collection. | Small, 37.0 | 37.0 | #### See Also - [Annotations List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations.htm "Returns a list of annotations and creates an annotation.") # Annotation Input An Analytics annotation. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | anchor | String | The anchor of the annotation. | Optional | 37.0 | | asset | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The referenced asset of the annotation. | Required | 37.0 | | feedElement | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The referenced feed element of the annotation. | Required | 37.0 | | resolved | Boolean | Indicates whether the state of the annotation is resolved or not. | Optional | 37.0 | #### See Also - [Annotations List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations.htm "Returns a list of annotations and creates an annotation.") - [Annotation Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations_id.htm "Returns an asset's annotations and updates an annotation.") # Annotation Resource Returns an asset's annotations and updates an annotation. Resource URL /wave/annotations/ Formats JSON Available Version 37.0 HTTP Methods GET PATCH Response body for GET and PATCH [Annotation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_annotation.htm "An Analytics annotation.") Request body for PATCH [Annotation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_annotation_input.htm "An Analytics annotation.") # Annotation Resources Annotate Analytics dashboard widgets with comments posted in the dashboard and in Chatter. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Annotations List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations.htm "Returns a list of annotations and creates an annotation.") | Returns a list of annotations and creates an annotation. | GET POST | /wave/annotations | | [Annotations Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations_id.htm "Returns an asset's annotations and updates an annotation.") | Returns an asset's annotations and updates an annotation | GET PATCH | /wave/annotations/ | - **[Annotations List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations.htm)** Returns a list of annotations and creates an annotation. - **[Annotation Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations_id.htm)** Returns an asset's annotations and updates an annotation. # Annotations List Resource Returns a list of annotations and creates an annotation. Resource URL /wave/annotations Formats JSON Available Version 37.0 HTTP Methods GET POST Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assetId | Id | The ID of the asset. | Required | 37.0 | The following REST URL shows how to use the assetId parameter in the GET request. /wave/annotations?assetId= Response body for GET [Annotation Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_annotation_collection.htm "A collection of annotations.") Request body for POST [Annotation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_annotation_input.htm "An Analytics annotation.") Response body for POST [Annotation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_annotation.htm "An Analytics annotation.") # API End-of-Life Policy Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to mature and improve the quality and performance of the API, versions that are more than three years old might cease to be supported. When an API version is to be deprecated, advance notice is given at least one year before support ends. Salesforce will directly notify customers using API versions planned for deprecation. | Salesforce API Versions | Version Support Status | Version Retirement Info | | --- | --- | --- | | Versions 31.0 through 66.0 | Supported. | | | Versions 21.0 through 30.0 | As of Summer ’25, these versions are retired and unavailable. | [Salesforce Platform API Versions 21.0 through 30.0 Retirement](https://help.salesforce.com/s/articleView?id=000389618&type=1&language=en_US) | | Versions 7.0 through 20.0 | As of Summer ’22, these versions are retired and unavailable. | [Salesforce Platform API Versions 7.0 through 20.0 Retirement](https://help.salesforce.com/s/articleView?id=000380623&type=1&language=en_US) | If you request any resource or use an operation from a retired API version, REST API returns 410:GONE error code. To identify requests made from old or unsupported API versions of REST API, access the free API Total Usage event type. # App Details The app details for a template configuration wizard page. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | guidancePanel | [GuidancePanel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_guidance_panel.htm "The guidance panel for a template configuration wizard page.") | The guidance panel to show for this app details page of the template wizard. | Small, 59.0 | 59.0 | | navigation | [PageNavigationInfo](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_navigation_info.htm "The navigation information for a template configuration wizard page.") | The navigation information for this app details page of the template wizard. | Small, 59.0 | 59.0 | # App Log The app log for app creation and updates. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | message | String | A log message entry. | Supplemental, 49.0 | 49.0 | # Array Type The array type of an Analytics template variable. ## Properties Inherits properties from [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | Object | The restricted list of enumerated values, where applicable for the inner variable types. | Small, 36.0 | 36.0 | | itemsType | [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable.") | The variable type of the array contents. | Small, 36.0 | 36.0 | | sizeLimit | [SizeLimit](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_size_limit.htm "The size limit of an Analytics template array type variable.") | The size limit of the array. | Small, 37 | 37.0 | # Asset Archival Input The assets to archive or restore, and the target archival state. ## Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | archived | Boolean | The target archival state for the requested assets. Set to true to archive (move to the Recycle Bin) the specified assets, or false to restore them. | Required | 68.0 | | assets | [AssetArchivalReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_archival_reference_input.htm "A reference to a single CRM Analytics asset to archive or restore.")\[\] | The list of assets to archive or restore. | Required | 68.0 | # Asset Archival Item Result The archival status and result for a single requested asset. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | archived | Boolean | Indicates whether the asset is currently archived (true) or restored (false). | Required | 68.0 | | id | ID | The 18-character Salesforce ID of the asset. | Required | 68.0 | | message | String | Describes why the operation failed for this asset. Present only when status is failure. | Optional | 68.0 | | status | String | The execution status for the individual asset operation. Valid values are success and failure. | Required | 68.0 | | type | String (Enum) | The type of CRM Analytics asset. Valid values are: dashboard and lens. | Required | 68.0 | # Asset Archival Reference Input A reference to a single CRM Analytics asset to archive or restore. ## Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | id | ID | The 18-character Salesforce ID of the asset. | Required | 68.0 | | type | String (Enum) | The type of CRM Analytics asset. Valid values are: dashboard and lens. | Required | 68.0 | # Asset Archival Resource Archives or restores one or more CRM Analytics assets by moving them to or from the Recycle Bin. ## Resource URL /analytics/assets/archive ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note Although this API is designed to handle bulk operations, it currently supports processing only one asset per request. ## Formats JSON ## Available Version 68.0 ## HTTP Methods POST ## Request body for POST [Asset Archival Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_archival_input.htm "The assets to archive or restore, and the target archival state.") ## Response body for POST [Asset Archival Result](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_archival_result.htm "The result of an asset archive or restore request.") ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note For authorization requirements, see [Connect REST API Authorization](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_authentication.htm "Connect REST API uses OAuth to securely identify your application before connecting to Salesforce."). For general information on request and response formats and HTTP status codes, see the Requests and Responses topics in this guide. # Asset Archival Result The result of an asset archive or restore request. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | action | String | The action performed on the target assets. Valid values are archive and restore. | Required | 68.0 | | archivalResults | [AssetArchivalItemResult](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_archival_item_result.htm "The archival status and result for a single requested asset.")\[\] | The archival status and result for each requested asset. | Required | 68.0 | | failureCount | Integer | The number of assets that failed to process. | Required | 68.0 | | overallStatus | String | The consolidated execution status of the request. Valid values are success, partial success, and failure. | Required | 68.0 | | successCount | Integer | The number of assets successfully processed. | Required | 68.0 | | totalCount | Integer | The total number of assets included in the request. | Required | 68.0 | # Asset File Resource Returns a preview file for an asset and updates the file. ## Resource URL /analytics/assetfiles//files/ ## Formats JSON ## Available Version 57.0 ## HTTP Methods GET PUT ## Request parameters for GET and PUT | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assetIdOrApiName | String | The ID or API name of the asset. | Required | 52.0 | | fileId | String | The ID of the file. | Required | 52.0 | ## Response body for GET A binary stream of the contents for the specified file. ## Request body for PUT A binary preview file. ## Response body for PUT [Analytics Data Asset File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_data_asset_file.htm "A file used for preview of an Analytics data asset.") # Asset Files List Resource Returns a collection of asset files for an asset and creates an asset file. ## Resource URL /analytics/assetfiles//files ## Formats JSON ## Available Version 57.0 ## HTTP Methods GET POST ## Request parameters for GET and POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assetIdOrApiName | String | The ID or API name of the asset. | Required | 52.0 | ## Response body for GET [Analytics Data Asset File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_data_asset_file.htm "A file used for preview of an Analytics data asset.") ## Request body for POST A binary preview file. ## Response body for POST [Analytics Data Asset File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_data_asset_file.htm "A file used for preview of an Analytics data asset.") # Asset Files Resources Analytics assets contain files to define their previews. Get a collection of files available and individual files, and create and update asset files ## Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Asset Files List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_assetfiles_id_files.htm "Returns a collection of asset files for an asset and creates an asset file.") | Returns a collection of asset files for an asset and creates an asset file. | GET POST | /analytics/assetfiles//files | | [Asset File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_assetfiles_id_files_id.htm "Returns a preview file for an asset and updates the file.") | Returns a preview file for an asset and updates the file. | GET PUT | /analytics/assetfiles//files/ | - **[Asset Files List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_assetfiles_id_files.htm)** Returns a collection of asset files for an asset and creates an asset file. - **[Asset File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_assetfiles_id_files_id.htm)** Returns a preview file for an asset and updates the file. # Asset History The history of an Analytics asset. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | createdBy | [WaveUser](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_user.htm "An Analytics user.") | The user who created the history record. | Small, 46.0 | 46.0 | | createdDate | Date | The date the history record was created for the asset. | Small, 46.0 | 46.0 | | historyUrl | String | The url to the history metadata details. | Small, 46.0 | 46.0 | | id | String | The id for the history record. | Small, 46.0 | 46.0 | | isCurrent | Boolean | Indicates whether this history record is the current version of the asset or not. | Small, 47.0 | 47.0 | | label | String | The optional label for the history record. | Small, 46.0 | 46.0 | | name | String | The generated name for the history record. | Small, 46.0 | 46.0 | | previewUrl | String | The url to a preview of how an asset looked at a particular point in time. This url doesn’t revert the asset. | Small, 46.0 | 46.0 | | revertUrl | String | The url to revert to this history record. | Small, 46.0 | 46.0 | | status | String | The optional status value of the asset. | Small, 47.0 | 47.0 | # Asset History Collection A collection of asset histories. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | histories | [AssetHistory](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_history.htm "The history of an Analytics asset.")\[\] | A list of asset histories | Small, 46.0 | 46.0 | #### See Also - [Dashboard Histories Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_histories.htm "Returns the dashboard histories with the specified ID or API name.") # Asset Publisher The publisher of an Analytics asset. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | assetId | String | The id for the asset | Small, 47.0 | 47.0 | | id | String | The id for the asset publisher record. | Small, 47.0 | 47.0 | | publisherUser | [WaveUser](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_user.htm "An Analytics user.") | The user in publish mode. | Small, 47.0 | 47.0 | #### See Also - [Dashboard Publishers List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_publishers.htm "Returns a list of users who are assigned as publishers for the given dashboard. Adds the current user to the list of publishers for the given dashboard. Removes all users from the dashboard's publisher list.") - [Dashboard Publisher Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_publishers_id.htm "Returns user detail information about the publisher for the given dashboard. Removes a user from the list of publishers for the given dashboard.") # Asset Publishers Collection A collection of asset publishers. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | publishers | [AssetPublisher](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_publisher.htm "The publisher of an Analytics asset.")\[\] | A list of asset publishers | Small, 47.0 | 47.0 | #### See Also - [Dashboard Publishers List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_publishers.htm "Returns a list of users who are assigned as publishers for the given dashboard. Adds the current user to the list of publishers for the given dashboard. Removes all users from the dashboard's publisher list.") # Asset Reference An Analytics asset reference. This wraps the [Base Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_asset_reference.htm "The base Analytics asset."). # Asset Reference Input An Analytics asset reference. This wraps the [BaseAssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_asset_reference_input.htm "The base Analytics asset."). # Asset Revert History Input The Analytics asset history to use for a revert request. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | historyId | String | The required source history id for this asset to revert to. | Required | 42.0 | | historyLabel | String | The history label to tag the revert change with. | Optional | 42.0 | #### See Also - [Dashboard Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_bundle.htm "Returns or updates the dashboard bundle with the specified ID or API name.") - [Dataflow Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm "Returns a dataflow. Reverts a dataflow to a previous version.") - [Lens Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_bundle.htm "Returns or updates the lens bundle with the specified ID or API name.") # Asset Xmd Resource Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard. ## Resource URL /wave/assets//xmds/asset For full details on Xmd, refer to the [Analytics Extended Metadata (Xmd) Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_xmd.meta/bi_dev_guide_xmd/bi_xmd_intro.htm). ## Formats JSON ## Available Version 42.0 ## HTTP Methods GET ## GET Response Body [Xmd](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd.htm "The extended metadata (Xmd) for an Analytics dataset version.") # Authenticate to Your Trailhead Playground Org After configuring the connected app, you must authorize your user with the connected app. ## Authorize the app Construct a URL by using this format. YOUR\_ORG\_URL/services/oauth2/authorize?response\_type=code&client\_id=YOUR\_CONSUMER\_KEY&scope=api refresh\_token offline\_access &redirect\_uri=https://oauth.pstmn.io/v1/callback - YOUR\_ORG\_URL is the fully qualified instance URL. - YOUR\_CONSUMER\_KEY is the consumer key noted when you set up the connected app. Next, paste the URL into a browser and execute it, and then select **Allow** for each of the scopes requested in the modal that appears. If you receive an alert from the callback, select **Open Postman.**. To verify that everything is authorized, from Setup, in the box, enter Connected Apps OAuth Usage, and confirm that you see your connected app with a user count of 1. # Auto-Install App Configuration The configuration for a auto-install app. ## Properties | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | appDescription | String | The description for the app. | Big, 54.0 | 54.0 | | appLabel | String | The label for the app. | Big, 54.0 | 54.0 | | appName | String | The developer name for the app. | Big, 54.0 | 54.0 | | autoShareWithLicensedUsers | Boolean | Indicates whether the Analytics application is automatically shared with users that are assigned the Analytics View Only Embedded App permission set (true) or not (false). | Small, 50.0 | 50.0 | | autoShareWithOriginator | Boolean | Indicates whether the Analytics application is automatically shared with the user that initiated the auto-install request (true) or not (false). | Small, 50.0 | 50.0 | | deleteAppOnConstructionFailure | Boolean | Indicates whether the Analytics application is deleted when a failure occurs on the WaveAppCreate request (true) or not (false). | Small, 50.0 | 50.0 | | failOnDuplicateNames | Boolean | Indicates whether the Analytics application creation fails when another asset exists with the same developer name (true) or not (false). | Small, 50.0 | 50.0 | | licenseAttributes | [LicenseAttributes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_license_attributes.htm "The Analytics license attributes.") | The license type to use to create the app with auto-install. This property is only used for WaveAppCreate requests. | Small, 58.0 | 58.0 | | values | Map | A map of application template variable values used to create or update the Analytics application. | Small, 50.0 | 50.0 | # Auto-Install App Configuration Input The configuration for an auto-install app. ## Request parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`appDescription`	String	The description for the Analytics app.	Optional	54.0
`appLabel`	String	The label for the Analytics app.	Optional	54.0
`appName`	String	The developer name for the Analytics app.	Optional	54.0
`autoShareWithLicensedUsers`	Boolean	Indicates whether the Analytics app is automatically shared with users that are assigned the Analytics View Only Embedded App permission set (`true`) or not (`false`).	Required	50.0
`autoShareWithOriginator`	Boolean	Indicates whether the Analytics app is automatically shared with the user that initiated the auto-install request (`true`) or not (`false`).	Required	50.0
`dataRefreshSchedule`	WeeklyScheduledItemInput	A weekly schedule to refresh the data for the app.	Optional	59.0
`deleteAppOnConstructionFailure`	Boolean	Indicates whether the Analytics app is deleted when a failure occurs on the `WaveAppCreate` request (`true`) or not (`false`).	Required	50.0
`dynamicOptions`	Map<Object, Object>	The map of dynamic options used to create or update the Analytics app. `productionType`: valid values include `ATF_3_0` `Classic` `runtimeLogEntryLevel`: valid values include `Fine` `Finer` `Finest` `Info` `Severe` `Warning`	Required	55.0
`failOnDuplicateNames`	Boolean	Indicates whether the Analytics app creation fails when another asset exists with the same developer name (`true`) or not (`false`).	Required	50.0
`licenseAttributes`	LicenseAttributesInput	The license type to use when creating the app. Honored only for `WaveAppCreate` requests.	Optional	54.0
`values`	Map<String, Object>	A map of app template variable values used to create or update the Analytics app.	Required	50.0

# Auto-Install Configuration The configuration for a auto-install request. Properties | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | appConfiguration | [AutoInstallAppConfiguration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_app_configuration.htm "The configuration for a auto-install app.") | The configuration used to create or update the Analytics application. | Supplemental, v50.0 | 50.0 | | parentRequestIds | String\[\] | The collection of the parent auto-install request ids this request depends on. | Supplemental, v50.0 | 50.0 | # Auto-Install Configuration Input The configuration for a auto-install app. ## Request parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | appConfiguration | [AutoInstallAppConfigurationInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_app_config_input.htm "The configuration for an auto-install app.") | The configuration used to create or update the Analytics application. | Required | 50.0 | | parentRequestIds | String\[\] | The collection of the parent auto-install request ids this request depends on. | Optional | 50.0 | # Auto-Install Request A auto-install request. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`appFromRequest`	WaveFolder[]	The Analytics application that this auto-install request is associated with.	Supplemental, 50.0	50.0
`configuration`	AutoInstallConfiguration[]	The configuration attributes for the auto-install request.	Supplemental, 50.0	50.0
`createdBy`	WaveUser	The user that created the auto-install request.	Small, 50.0	50.0
`createdDate`	Date	The date and time the auto-install request was created.	Small, 50.0	50.0
`failedReason`	AutoInstallRequestFailedReasonEnum	The reason that the auto-install request failed, where applicable. Valid values are: `AppConstructionFailure` `AppCreateFailure` `AppInstallationSkipped` `AppUpdateFailure` `CancelFailed` `DeleteFailed` `DependencyCancelled` `DependencyFailure` `FailedOther` `FailedToEnqueue` `OrganizationIncompatible` `RequestCancelled` `RetriesExhausted` `WaveDisabled`	Small, 50.0	50.0
`folderId`	String	The Analytics application folder ID for the auto-install request.	Small, 50.0	50.0
`folderLabel`	String	The Analytics application folder label for the auto-install request.	Small, 50.0	50.0
`id`	String	The ID for the auto-install request.	Small, 50.0	50.0
`lastModifiedBy`	WaveUser	The user that last modified the auto-install request.	Small, 50.0	50.0
`lastModifiedDate`	Date	The date and time the auto-install request was last modified.	Small, 50.0	50.0
`parentRequests`	AutoInstallRequest[]	The collection of auto-install requests that the auto-install request depends on.	Supplemental, 50.0	50.0
`requestLog`	String	The log for the auto-install request.	Big, 50.0	50.0
`requestName`	String	The user specified name for the auto-install request.	Small, 50.0	50.0
`requestStatus`	AutoInstallRequestStatusEnum	The status of the auto-install request. Valid values are: `AppInProgress` `Cancelled` `Enqueued` `Failed` `InProgress` `New` `Skipped` `Success`	Small, 50.0	50.0
`requestTemplate`	Template	The Analytics template used to create and update the app, where applicable.	Supplemental, 50.0	50.0
`requestType`	AutoInstallRequestTypeEnum	The type of the auto-install request. Valid values are: `OrgCompatibilityCheck` `StartDataflow` `WaveAppAutoUpdate` `WaveAppCreate` `WaveAppDelete` `WaveAppUpdate` `WaveEnable`	Small, 50.0	50.0
`templateApiName`	String	The Analytics template API name or ID for the auto-install request.	Small, 50.0	50.0
`templateVersion`	String	The Analytics template version for the auto-install request.	Small, 50.0	50.0
`url`	String	The URL to get the auto-install request.	Small, 50.0	50.0

Parameter Name	Type	Description	Required or Optional	Available Version
`configuration`	AutoInstallConfigurationInput	The auto-install request configuration.	Required	50.0
`folderId`	String	The Analytics application folder ID.	Required	50.0
`requestName`	String	The name of the auto-install request.	Required	50.0
`requestType`	AutoInstallRequestTypeEnum	The auto-install request type. Valid values are: `OrgCompatibilityCheck` `StartDataflow` `WaveAppAutoUpdate` `WaveAppCreate` `WaveAppDelete` `WaveAppUpdate` `WaveEnable`	Required	50.0
`templateApiId`	String	The Analytics template API name or ID.	Required	50.0

#### See Also - [Auto-Install Requests List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests.htm "Returns a collection of auto-install requests for Analytics embedded apps, creates an auto-install request, or deletes groups of auto-install requests by an Analytics folder ID or a template API name.") # Auto-Install Request Resource Returns an auto-install request for an Analytics embedded app, updates, and deletes an auto-install request. Resource URL /wave/auto-install-requests/ Formats JSON Available Version 50.0 HTTP Methods GET PATCH DELETE Response body for GET and PATCH [Auto-Install Request](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_request.htm "A auto-install request.") Request body for PATCH [Auto-Install Request Update Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_request_update_input.htm "The update for an auto-install request.") # Auto-Install Request Resources Auto-Install requests are used to create, update, and delete Analytics embedded apps. Analytics embedded apps are run-time implementations of Analytics templates and instead of user interaction, they’re managed via auto-install requests. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Auto-Install Requests List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests.htm "Returns a collection of auto-install requests for Analytics embedded apps, creates an auto-install request, or deletes groups of auto-install requests by an Analytics folder ID or a template API name.") | Returns a collection of auto-install requests for Analytics embedded apps, creates an auto-install request, or deletes groups of auto-install requests by a Analytics folder ID or a template API name. | GET POST DELETE | /wave/auto-install-requests | | [Auto-Install Request Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests_id.htm "Returns an auto-install request for an Analytics embedded app, updates, and deletes an auto-install request.") | Returns an auto-install request for an Analytics embedded app, updates, and deletes an auto-install request. | GET PATCH DELETE | /wave/auto-install-requests/ | - **[Auto-Install Requests List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests.htm)** Returns a collection of auto-install requests for Analytics embedded apps, creates an auto-install request, or deletes groups of auto-install requests by an Analytics folder ID or a template API name. - **[Auto-Install Request Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests_id.htm)** Returns an auto-install request for an Analytics embedded app, updates, and deletes an auto-install request. # Auto-Install Request Update Input The update for an auto-install request. Properties AutoInstallRequestUpdateInput inherits properties from the abstract [BaseAutoInstallRequestInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_auto_install_request_input.htm "The base auto-install request input."). These base properties appear in AutoInstallRequestUpdateInput alongside the properties defined explicitly in the following table. | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | requestLog | String | The log of the auto-install request. | Required | 50.0 | #### See Also - [Auto-Install Request Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests.htm "Returns a collection of auto-install requests for Analytics embedded apps, creates an auto-install request, or deletes groups of auto-install requests by an Analytics folder ID or a template API name.") # Auto-Install Requests List Resource Returns a collection of auto-install requests for Analytics embedded apps, creates an auto-install request, or deletes groups of auto-install requests by an Analytics folder ID or a template API name. Resource URL /wave/auto-install-requests Formats JSON Available Version 50.0 HTTP Methods GET POST DELETE Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`folderId`	ID	Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder.	Optional	50.0
`folderLabel`	String	Filters the results to include only the contents of a specific folder by label.	Optional	50.0
`pageSize`	Integer	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	50.0
`requestName`	String	Filters the results to include only the contents with a specific auto-install request name.	Optional	50.0
`requestStatuses`	AutoInstallRequestStatusEnum[]	Filters the results to include only the contents with a specific auto-install request status. Valid values include: `AppInProgress` `Cancelled` `Enqueued` `Failed` `InProgress` `New` `Skipped` `Success`	Optional	50.0
`requestTypes`	AutoInstallRequestTypeEnum[]	Filters the results to include only the contents with a specific auto-install request type. Valid values include: `OrgCompatibilityCheck` `StartDataflow` `WaveAppAutoUpdate` `WaveAppCreate` `WaveAppDelete` `WaveAppUpdate` `WaveEnable`	Optional	50.0
`searchOptions`	AutoInstallRequestSearchOptionEnum[]	Filters the results to include only the contents with specific search options. Valid values include: `ExcludeNonExistingApps` `MostRecentOnlyByTemplateAndFolder` `NonExistingAppsOnly`	Optional	50.0
`sortOptions`	AutoInstallRequestSortOptionEnum[]	Sorts the results according to the given sort option. Valid values include: `CreatedDateAscending` `CreatedDateDescending` `FolderIdAscending` `FolderIdDescending` `FolderLabelAscending` `FolderLabelDescending` `LastModifiedDateAscending` `LastModifiedDateDescending` `RequestNameAscending` `RequestNameDescending` `RequestStatusAscending` `RequestStatusDescending` `RequestTypeAscending` `RequestTypeDescending` `TemplateApiNameAscending` `TemplateApiNameDescending`	Optional	50.0
`templateApiName`	String	Filters the results to include only the contents created from a specific application template.	Optional	50.0

The following REST URL shows how to use the request parameters to filter and sort in the GET request. /wave/auto-install-requests?searchOptions=ExcludeNonExistingApps&sortOptions=RequestStatusAscending Response body for GET [Auto-Install Request Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_request_collection.htm "A collection of auto-install requests.") Request body for POST [Auto-Install Request Insert Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_request_insert_input.htm "The insert for an auto-install request.") Response body for POST [Auto-Install Request](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_request.htm "A auto-install request.") # Backup and Restore Previous Versions of CRM Analytics Assets with History API When you edit CRM Analytics dashboards, lenses, recipes, and dataflows, CRM Analytics backs them up automatically. When you save a new version of an asset, CRM Analytics creates a snapshot of it. You can then preview snapshots and revert to previous versions using the REST History API. Every time you save a new version of a dashboard, lens, recipe, or dataflow, CRM Analytics saves the older version. It also saves dashboard and lens conditional formatting. CRM Analytics saves 20 versions of an asset, including 10 tagged and 10 untagged versions. When you save more than 20 new versions of an asset, CRM Analytics saves the new version and purges older versions. When the limit is reached and the save is for a tagged version, the oldest tagged version is purged. An untagged version save purges the oldest untagged version. To increase this limit, contact Salesforce and ask your representative to increase the org value **Maximum analytics asset histories to track in the database**, also known as AnalyticsMaxHistories. You can add tags that describe asset versions to give you and other team members reminders of what's been changed and why. You can use either manual or automatic tagging. CRM Analytics gives you two ways to manually tag an asset version. - The Save dialog displays a Version History box when you save a dashboard or lens. Enter a short description of your changes there. (Dataflows don't have a user interface for adding tags to previous versions.)![The Version History field in the dashboard Save dialog](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/dev_guides/bi_dev_guide_rest/images/bi_dashboard_save2.png) - You can also tag changes with the public REST API. Use the API to tag history records with a description, which you can do after saving the asset. You can edit existing descriptions. \*PATCH: /services/data/v46.0/wave/dashboards/0FKxx0000004CAeGAM/histories/0Rmxx0000004Cx2CAE\* \*REQUEST BODY: {"label" : "new description"}\* CRM Analytics automatically adds tags to history records in one of two ways. - When you create and save the initial version of an asset, CRM Analytics adds the tag Initial Create to the history record. - When you create or upgrade an app from a template, CRM Analytics tags history records for the app. The tag includes the template action, template name, and template version. This information helps you restore the correct previous version of an asset after you upgrade an app from a new template version. ## Previewing and Reverting to Previous Asset Versions To get a list of history records for an asset, either use cURL or Postman and execute an API call. Or enter the appropriate command in the Salesforce Command Line Interface (CLI) with the CRM Analytics plugin. ![Warning](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note_warning.png) #### Warning A previous version of a dashboard doesn’t work if assets that the version relies on have been removed from CRM Analytics. Those assets can be other dashboards, datasets, lenses, and images. - Dashboard history records. - API call: GET: /services/data/v526.0/wave/dashboards//histories - CLI command: sf analytics dashboard history list - Lens history records. - API call: GET: /services/data/v52.0/wave/dashboards//histories - CLI command: sf analytics lens history list - Recipe history records. - API call: GET: /services/data/v52.0/wave/recipes//histories - Dataflow history records. - API call: GET: /services/data/v52.0/wave/dataflows//histories - CLI command: sf analytics dataflow history list Optionally, you can navigate to the History API endpoint with the URL in historiesUrl in the Asset Response (HATEOAS) and execute it with cURL or Postman. Or manually execute the following REST calls from cURL or Postman: - Get a list of all dashboards: GET: /services/data/v52.0/wave/dashboards - Find a dashboard, use its details URL in the response body: GET: /services/data/v52.0/wave/dashboards/ - Get a list of histories, use the historiesUrl in the dashboard details response: GET: /services/data/v52.0/wave/dashboards/\*/histories\* ## Preview a Previous Version After listing asset version histories, preview the JSON for a version. During preview, you see the JSON as it looked when it was saved. To preview the JSON for previous asset versions, use the URL from previewUrl in the response body and execute it with cURL or Postman. ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note Dataflows have two preview URLs: previewUrl and privatePreviewUrl. The private preview URL provides the same JSON format as you see if you downloaded the JSON file declaratively using the CRM Analytics dataflow editor. The preview URL provides the public version of the JSON. ## Restore a Previous Version After you confirm you’re previewing the correct asset version, restore it using either REST API calls or the CLI. Using REST API calls, in the version you want to revert to, locate the revertUrl. Then copy the historyId of the version you want to restore. You use it in the request body. Now, to restore an asset from the previous version, perform a PUT. \*PUT: /services/data/v52.0/wave/dashboards/\*/bundle\*\* \*REQUEST BODY: {"historyId": ", historyLabel" : "optional description of new change"}\* The CLI commands for restoring assets are as follows: - Dashboards. sf analytics dashboard history revert -i -h - Lenses. sf analytics lens history revert -i -h - Dataflows. sf analytics dataflow history revert -i -h historyid is the ID for the version of the asset you want to restore. ## Limitations When you restore the previous version of an asset, the asset doesn’t run as expected. If the asset depends on other assets (for example, datasets) and those assets have been deleted or modified, you can get errors. However, every time you restore a previous version, you create a history record. You can always restore the last working copy. When you delete an asset, all history is deleted with it, and you can’t undelete it. Currently, CRM Analytics doesn’t back up previous versions of dataset XMD files. # Base Asset Input The base Analytics asset input. Inherited by BaseDashboardInput, BaseLensInput, [DataConnectorInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_connector_input.htm "An Analytics data connector."), [DataflowInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataflow_input.htm "An Analytics dataflow."), [DatasetInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataset_input.htm "An Analytics dataset."), and [TemplateInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_input.htm "An Analytics template."). Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | description | String | Short description of the asset | Required for POST; Optional in PATCH | 36.0 | | name | String | The asset developer name. | Required for POST; Not allowed to edit in PATCH | 36.0 | | label | String | The asset label. | Optional in POST and PATCH | 37.0 | # Base Asset Reference The base Analytics asset. Inherited by [Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference."), [Image Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_image_asset_reference.htm "A image asset for Analytics."), [Slack Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_slack_reference.htm "The reference for a Slack entity."), and [Typed Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_typed_asset_reference.htm "A typed Analytics asset reference."). Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The 18 character ID of the asset. | Small, 36.0 | 36.0 | | label | String | The asset label. | Small, 36.0 | 36.0 | | name | String | The asset developer name. | Small, 36.0 | 36.0 | | namespace | String | The namespace that qualifies the asset name. The default is the current organization's namespace, which is "empty namespace" for all organizations, except those developer edition orgs that have set a namespace. | Small, 37.0 | 37.0 | | url | String | The asset URL. | Small, 36.0 | 36.0 | # Base Asset Reference Input The base Analytics asset. Inherited by [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference."), [SlackReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_slack_reference_input.htm "The reference for a Slack entity."), and [TypedAssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_typed_asset_reference_input.htm "A typed Analytics asset reference."). Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | description | String | Short description of the asset | Required for POST; Optional in PATCH | 36.0 | | name | String | The asset developer name. | Required for POST; Not allowed to edit in PATCH | 36.0 | | label | String | The asset label. | Optional in POST and PATCH | 37.0 | # Base Auto-Install Request Input The base auto-install request input. Inherited by [Auto-Install Request Insert Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_request_insert_input.htm "The insert for an auto-install request.") and [Auto-Install Request Update Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_request_update_input.htm "The update for an auto-install request."). Properties

Parameter Name	Type	Description	Required or Optional	Available Version
`requestStatus`	AutoInstallRequestStatusEnum	The auto-install request status. Valid values include: `AppInProgress` `Cancelled` `Enqueued` `Failed` `InProgress` `New` `Skipped` `Success`	Optional	50.0

# Base Collection Reference The base Analytics collection. Inherited by [Watchlist](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist.htm "An Analytics watchlist collection."). Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | nextPageUrl | String | The URL for the next page of contents in the collection. | Small, 36.0 | 36.0 | | totalSize | Integer | The total count of the elements in the collection. | Small, 36.0 | 36.0 | | url | String | The URL for the collection. | Small, 36.0 | 36.0 | # Base File The base Analytics file. Inherited by [Analytics Data Asset File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_data_asset_file.htm "A file used for preview of an Analytics data asset.") and [Lens File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_file.htm "A file used to generate a lens."). Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`contentType`	String	The content type of the file.	Small, 36.0	36.0
`fileLength`	Integer	The length of the file in KB.	Small, 36.0	36.0
`fileName`	String	The name of the file.	36.0
`description`	String	Short description of the asset.	Small, 36.0	36.0
`id`	String	The 18 character ID of the file.	Small, 36.0	36.0
`lastModifiedDate`	Date	The last time the file was modified,.	Small, 36.0	36.0
`url`	String	The file URL.	Small, 36.0	36.0

# Base Notification Action Configuration The base Analytics notification action configuration. Inherited by [PostToSlackNotificationActionConfiguration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_post_to_slack_notification_action_configuration.htm "The notification action configuration for posting to Slack.") and [SendToEmailNotificationActionConfiguration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_send_to_email_notification_action_configuration.htm "The notification action configuration for sending an email."). # Base Notification Action Configuration Input The base Analytics notification action configuration. Inherited by [PostToSlackNotificationActionConfigurationInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_post_to_slack_notification_action_configuration_input.htm "The notification action configuration for posting to Slack.") and [SendToEmailNotificationActionConfigurationInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_send_to_email_notification_action_configuration_input.htm "The notification action configuration for sending an email."). # Base Object Type The base type for an Analytics template object variable. ## Properties Inherits properties from [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable."). Inherited by [CalculatedInsightFieldType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm "The sobject field type of an Analytics template variable."), [CalculatedInsightType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm "The sobject type of an Analytics template variable."), [DataLakeObjectFieldType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm "The sobject field type of an Analytics template variable."), [DataLakeObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm "The sobject type of an Analytics template variable."), [DataModelObjectFieldType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm "The sobject field type of an Analytics template variable."), [DataModelObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm "The sobject type of an Analytics template variable."), [DatasetAnyFieldType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_any_field_type.htm "The dataset generic field type of an Analytics template variable."), [DatasetDateType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_date_type.htm "The date in a dateset type of an Analytics template variable."), [DatasetDimensionType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_dimension_type.htm "The dimension in a dateset type of an Analytics template variable."), [DatasetMeasureType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_measure_type.htm "The measure in a dateset type of an Analytics template variable."), [DatasetType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_type.htm "The dateset type of an Analytics template variable."), [ObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_object_type.htm "The object type of an Analytics template variable."), [SObjectFieldType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm "The sobject field type of an Analytics template variable."), and [SObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm "The sobject type of an Analytics template variable."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | properties | Map | A map of defined properties and types of the object. | Small, 36.0 | 36.0 | | required | String\[\] | A list of required properties for the object. | Small, 36.0 | 36.0 | | strictValidation | Boolean | Indicates whether to use strict validation when unexpected properties exist in the object payload (true) or not (false). | Small, 36.0 | 36.0 | # Base Subscription Input The base subscription request input. Inherited by [Subscription Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_input.htm "An Analytics subscription.") and [Watchlist Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_schedule_input.htm "An Analytics watchlist schedule."). Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | actions | [NotificationActionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_notification_action_input.htm "A notification action for an Analytics subscription.")\[\] | The list of actions for the subscription | Required | 53.0 | | active | Boolean | Indicates whether the subscription schedule is active (true) or not (false). | Required | 47.0 | | schedule | [SubscriptionScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_schedule_input.htm "An Analytics subscription input.")\[\] | The schedule for the subscription | Required | 47.0 | | source | [SubscriptionSourceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_source_input.htm "The subscription source.")\[\] | The information about the source and type for the subscription | Required | 522.0 | # Base Templated Asset A base Analytics asset created from a template. ## Properties Inherited by [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard.htm "An Analytics dashboard.") and [Lens](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens.htm "Am Analytics lenses."). BaseTemplatedAsset inherits properties from the abstract [BaseWaveAssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear in BaseTemplatedAsset alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | clonedTemplateOrigin | String | If the asset was cloned from an asset that was created from a template, this is the template origin of the original asset. | Small, 56.0 | 56.0 | | templateAssetSourceName | String | If the asset was created from a template, this is the corresponding template asset developer name. | Small, 52.0 | 52.0 | | templateSourceId | String | If the asset was created from a template, this is the corresponding template name or ID. | Small, 52.0 | 52.0 | # Base Wave Asset The base Analytics asset. Inherited by [Analytics Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_asset.htm "An Analytics asset."), [Base Templated Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_templated_asset.htm "A base Analytics asset created from a template."), [Contextual Source Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_contextual_source_asset.htm "A contextual representation of an Analytics dashboard."), [Coverage Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_contextual_source_asset.htm "A contextual representation of an Analytics dashboard."), [Dashboard Context Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_context_asset.htm "A contextual representation of an embedded Analytics dashboard."), [Data Connector](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector.htm "An Analytics data connector."), [Dataflow Job Node](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node.htm "A node in a dataflow job."), [Dataflow Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job.htm "An Analytics dataflow job."), [Dataflow](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow.htm "An Analytics dataflow."), [Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset.htm "An Analytics dataset."), [Dataset Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version.htm "A specific version of an Analytics dataset."), [Lens Source Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_source_asset.htm "A contextual representation of an Analytics lens."), [Recipe Configuration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_recipes.meta/api_recipes/sforce_recipes_api_responses_recipe_configuration.htm), [Recipe](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_recipes.meta/api_recipes/sforce_recipes_api_responses_recipe.htm), [Replicated Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_dataset.htm "An Analytics replicated dataset, also know as a connected object."), [Report Source Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_report_source_asset.htm "A contextual representation of a report asset."), [Wave Collection Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_item.htm "An item in a collection of Analytics resources."), [Wave Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection.htm "A collection of Analytics resources."), and [Wave Folder](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder.htm "An Analytics folder."). Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`assetSharingUrl`	String	The URL for opening this asset in the user interface. This is a form of deep linking. The server examines the link parameters, which can include urlType, assetId, orgId, and loginHost, as well as other optional parameters, and translates as necessary to produce the correct result on the target client. For example, it opens the asset on a desktop client, or mobile if you are on a mobile OS.	Small, 36.0	36.0
`createdBy`	WaveUser	The user who created the asset.	Small, 36.0	36.0
`createdDate`	Date	The time at which the asset was created, in ISO8601 date format.	Small, 36.0	36.0
`description`	String	Short description of the asset.	Small, 36.0	36.0
`id`	String	The 18 character ID of the asset.	Small, 36.0	36.0
`label`	String	The asset label.	Small, 36.0	36.0
`lastAccessedDate`	Date	The last time the asset was accessed, in ISO8601 date format.	Small, 36.0	36.0
`lastModifiedBy`	WaveUser	The user who last updated the asset.	Small, 36.0	36.0
`lastModifiedDate`	Date	The last time the asset was modified, in ISO8601 date format.	Small, 36.0	36.0
`name`	String	The asset developer name.	Small, 36.0	36.0
`namespace`	String	The namespace that qualifies the asset name. The default is the current organization's namespace, which is "empty namespace" for all organizations, except those developer edition orgs that have set a namespace.	Small, 36.0	36.0
`permissions`	Permissions	The permissions for the current user.	Small, 36.0	36.0
`type`	ConnectWaveAssetTypeEnum	The asset type. The default type is Dashboard. Valid types are: `Collection` `Component` `ContextualDashboard` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataCloudReport` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `TableauDashboard` `TableauWorkbook` `Template` `Widget` `Workflow`	Optional, Small, 36.0	36.0
`url`	String	The asset URL.	Small, 36.0	36.0

# Base Wave Folder Input The base Analytics folder asset. Inherited by [Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_input.htm "An Analytics folder. This implements BaseWaveFolderInput.") and [Wave Folder Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_template_input.htm "A templated Analytics folder. This implements BaseWaveFolderInput."). ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assetIcon | String | The icon enumeration that best represents the new folder or application. Valid values are 1.png through 20.png. | Optional | 36.0 | | description | String | The description of the folder or application. | Optional | 36.0 | | label | String | The user-facing name of the folder or application. | Optional | 36.0 | | name | String | The internal API name of the new folder or application. | Optional | 36.0 | # Base Xmd Dimension Custom Action Input The base custon action for an Xmd dimension. Inherited by [XmdDimensionCustomActionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dimension_custom_action_input.htm "A custom action for an Xmd dimension.") and [XmdDerivedDimensionCustomActionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_dimension_custom_action_input.htm "A custom action for an Xmd derived dimension."). Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | icon | String | The icon for the custom action. | Required | 36.0 | | method | String | The method for the custom action. | Required | 36.0 | | target | String | The target for the custom action. | Required | 36.0 | | tooltip | String | The tooltip for the custom action. | Required | 36.0 | | url | String | The URL for the custom action. | Required | 36.0 | # Base Xmd Dimension Input The base Xmd dimension for dimensions and derived dimensions. Inherited by [XmdDimensionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dimension_input.htm "The extended metadata (Xmd) for a dimension in an Analytics dataset.") and [XmdDerivedDimensionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_dimension_input.htm "The extended metadata (Xmd) for a derived dimension in an Analytics dataset."). Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | conditionalFormatting | Map # Base Xmd Measure Input The base Xmd measure for measures and derived measures. Inherited by [XmdMeasureInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_measure_input.htm "The extended metadata (Xmd) for a measure in an Analytics dataset.") and [XmdDerivedMeasureInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_measure_input.htm "The extended metadata (Xmd) for a derived measure in an Analytics dataset."). Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | conditionalFormatting | Map # Boolean Type The boolean type of an Analytics template variable. ## Properties Inherits properties from [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | Boolean\[\] | The restricted list of enumerated boolean values. | Small, 36.0 | 36.0 | # Bounding Box A bounding box of a map. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | bottom | Double | The bottom boundary of the geo map | Small, 39.0 | 39.0 | | left | Double | The left boundary of the geo map | Small, 39.0 | 39.0 | | right | Double | The right boundary of the geo map | Small, 39.0 | 39.0 | | top | Double | The top boundary of the geo map | Small, 39.0 | 39.0 | # Calculated Insight Field Type The calculated insight field type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable.").

Property Name	Type	Description	Filter Group and Version	Available Version
`dataType`	String	The calculated insight field data type when a default field isn't supplied. Valid values are: string number date_time date	Small, 58.0	58.0
`fieldType`	String	The calculated insight field type when a default field isn't supplied. Valid values are: dimension measure	Small, 58.0	58.0

# Calculated Insight Type The calculated insight type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). # Charts Geodata File List Resource Return the binary file associated with a geodata definition. Resource URL /eclair/geodata//file Formats JSON Available Version 38.0 HTTP Methods GET GET Response Body StreamedRepresentation. Returns a binary stream of the contents of the specified file. # Charts Geodata List Resource Returns a collection of geodata definitions and creates a geodata definition. Resource URL /eclair/geodata Formats JSON Available Version 38.0 HTTP Methods GET POST Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | page | Int | The page number you want to view. | Optional | 38.0 | | pageSize | Int | The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. | Optional | 38.0 | Response body for GET [Geo Data Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_geo_data_collection.htm "A collection of the geo data used by a map.") Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | geoDataFile | Binary | The geodata JSON file to upload. | Required | 39.0 | | geoDataObject | [GeoDataInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_geo_data_input.htm "The geo data used by a map.") | All the relevant information about the geodata, such as {"label": "My GeoData"}. | Required | 39.0 | Response body for POST [Geo Data](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_geo_data.htm "The geo data used by a map.") The following JSON shows how to create a geodata resource from a GeoJson file. { "label": "GeoJsonLabel", "name": "GeoJsonName" } # Charts Geodata Resource Returns a geodata definition, updates, or delete a geodata definition. Resource URL /eclair/geodata/ Formats JSON Available Version 38.0 HTTP Methods DELETE GET PATCH Response body for GET and PATCH [Geo Data](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_geo_data.htm "The geo data used by a map.") PATCH Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | geoDataFile | Binary | The geodata JSON file to upload. | Required | 39.0 | | geoDataObject | [GeoDataInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_geo_data_input.htm "The geo data used by a map.") | All the relevant information about the geodata, such as { "label": "My GeoData" }. | Required | 39.0 | # Charts Maps List Resource Returns a list of maps or creates a map. Resource URL /eclair/maps Formats JSON Available Version 38.0 HTTP Methods GET POST Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | page | Int | The page number you want to view. | Optional | 38.0 | | pageSize | Int | The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. | Optional | 38.0 | Response body for GET [Map Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_map_collection.htm "A collection of maps.") Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | geoMapObject | [MapInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_map_input.htm "A map for an Eclair chart.") | All the relevant information about the map, such as {"label": "My Map"}. | Required | 39.0 | Response body for POST [Map](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_map.htm "A map object.") The following JSON shows how to create a map resource from a GeoJson file with the optional bounding box. { "boundingBox": { "bottom": 40.5534, "left": -80.251, "right": -79.8211 "top": 40.3287 }, "geoData": { "id": "" }, "name":"developer\_name\_for\_map", "label": "display\_label\_for\_map", "projection" : "equirectangular" } # Charts Maps Resource Returns, updates, or deletes a specific map. Resource URL /eclair/maps/ Formats JSON Available Version 38.0 HTTP Methods DELETE GET PATCH Response body for GET and PATCH [Map](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_map.htm "A map object.") PATCH Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | geoMapObject | [MapInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_map_input.htm "A map for an Eclair chart.") | All the relevant information about the map, such as {"label": "My Map"}. | Required | 39.0 | # Collaboration Room Notification Recipient The Slack recipient of a notification. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | platformId | String | The Slack platform ID for the recipient. | Small, 53.0 | 53.0 | # Collaboration Room Notification Recipient Input The Slack recipient of a notification. Properties | Property Name | Type | Description | Reequired or Optional | Available Version | | --- | --- | --- | --- | --- | | platformId | String | The Slack platform ID for the recipient. | Required | 53.0 | # Collection Pin The pinning rules for an Analytics collection. Properties

Parameter Name	Type	Description	Filter Group and Version	Available Version
`id`	ConnectWaveShareTypeEnum	The ID for the collection pin rule.	Small, v52.0	52.0
`pinnedFor`	ID	The id of a group, a role, or a user the pinning rule is defined for.	Small, v52.0	52.0
`type`	CollectionPinTypeEnum	The type of pinning. Valid values are: `All` `Desktop` `Mobile` `None`	Small, v52.0	52.0

# Collection Resources Analytics collections let users manage their own groups of items and personalize their Analytics Studio home page. ## Available resources:

Resource	Description	Supported HTTP Method	Resource URL
Collections List Resource	Get and create lists of collections of Analytics resources.	GET POST	`/analytics/collections` `/wave/collections`
Collections Resource	Get, update, or delete a collection of Analytics resources.	GET PATCH DELETE	`/analytics/collections/<collectionId>` `/wave/collections/<collectionId>`
Collection Items List Resource	Returns a list of Analytics collection items and creates or updates the collection item list.	GET PATCH POST	`/analytics/collections/<collectionId>/items` `/wave/collections/<collectionId>/items`
Collection Item Resource	Delete an Analytics resource item from a collection.	DELETE	`/analytics/collections/<collectionId>/items/<collectionItemId>` `/wave/collections/<collectionId>/items/<collectionItemId>`
Collection Bulk Items Resource	Add items in bulk to the collection.	POST	`/analytics/collections/<collectionId>/bulk-items` `/wave/collections/<collectionId>/bulk-items`

- **[Collections List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections.htm)** Returns a list of collections or creates a collection. Each collection contains Analytics resource items. - **[Collections Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_collections.htm)** Returns, updates, or deletes a collection. Each collection contains Analytics resource items. - **[Collections Items List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm)** Returns a list of Analytics collection items and creates or updates the collection item list. - **[Collections Item Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_item.htm)** Deletes an item from the collection. - **[Collections Bulk Items Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_bulk_items.htm)** Add items in bulk to the collection. # Collection Subscription Source The collection subscription source. Properties CollectionSubscriptionSource inherits properties from the abstract [SubscriptionSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_source.htm "The base Analytics subscription source."). These base properties appear in CollectionSubscriptionSource alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | asset | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The collection asset for the subscription. | Small, 52.0 | 52.0 | # Collection Subscription Source Input The collection subscription source. Properties CollectionSubscriptionSourceInput inherits properties from the abstract [SourceDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_details_input.htm "The abstract source details for a subscription."). These base properties appear in CollectionSubscriptionSourceInput alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | asset | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The collection asset for the subscription. | Required | 52.0 | # Collections Bulk Items Resource Add items in bulk to the collection. ## Resource URL /analytics/collections//bulk-items /wave/collections//bulk-items ## Formats JSON ## Available Version 63.0 ## HTTP Methods POST ## Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | collectionId | String | The ID of the collection the item belongs to. | Required | 63.0 | ## Request body for POST [Wave Collection Item Bulk Add Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_bulk_add_input.htm "Bulk items to add to a collection of Analytics resources.") ## Response body for POST [Wave Collection Item List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_item_list.htm "A list of items in a collection of Analytics resources.") # Collections Item Resource Deletes an item from the collection. ## Resource URL /analytics/collections//items/ /wave/collections//items/ ## Formats JSON ## Available Version 52.0 ## HTTP Methods DELETE ## Request parameters for DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | collectionId | String | The ID of the collection the item belongs to. | Required | 52.0 | | collectionItemId | String | The ID of the item to delete from the collection. | Required | 52.0 | ## DELETE Request /analytics/collections//items/ /wave/collections//items/ # Collections Items List Resource Returns a list of Analytics collection items and creates or updates the collection item list. ## Resource URL /analytics/collections//items /wave/collections//items ## Formats JSON ## Available Version 52.0 ## HTTP Methods GET POST PATCH ## Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`itemType`	CollectionItemAssetTypeEnum	Filters the results by the collection item asset type. Valid values are: `Component` `Dashboard` `DashboardSavedView` `Lens` `LightningDashboard` `Report` `TableauDashboard` `TableauWorkbook`	Optional	52.0
`limit`	Integer	The limit of collections to return.	Optional	52.0
`mobileOnly`	Boolean	Filters the results to return only mobile asset items.	Optional	52.0
`offset`	Integer	Indicates the starting index for list of collections items returned. The default value is 0.	Optional	52.0
`pageToken`	String	The token to use for next page.	Optional	52.0

## Response body for GET and PATCH [Wave Collection Item List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_item_list.htm "A list of items in a collection of Analytics resources.") ## Request body for POST [Wave Collection Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_input.htm "An item in a collection of Analytics resources.") ## Response body for POST [Wave Collection Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_item.htm "An item in a collection of Analytics resources.") ## Request body for PATCH [Wave Collection Item List Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_list_input.htm "A list of items in a collection of Analytics resources.") # Collections List Resource Returns a list of collections or creates a collection. Each collection contains Analytics resource items. ## Resource URL /analytics/collections /wave/collections ## Formats JSON ## Available Version 52.0 ## HTTP Methods GET POST ## Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | editableOnly | Boolean | Filters the results for only collections the current user has edit access to. | Optional | 52.0 | | includeItems | Boolean | Indicates whether the collection items are returned in the response (true) or not (false). | Optional | 52.0 | | label | String | Filters the results for collections list to match the specified label. | Optional | 54.0 | | limit | Integer | The limit of collections to return. | Optional | 52.0 | | offset | Integer | Indicates the starting index for list of collections returned. The default value is 0. | Optional | 52.0 | | pageToken | String | The token to use for next page. | Optional | 52.0 | | pinnedOnly | Boolean | Filters the results for pinned collections only. | Optional | 52.0 | | type | CollectionTypeEnum | Filters the results by collection type. Valid values are: Static. The default is to return all types of collections. | Optional | 52.0 | | visibleOnly | Boolean | Indicates whether only visible collection items are returned in the response (true) or not (false). | Optional | 57.0 | ## Response body for GET [Wave Collection List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_list.htm "A list of Analytics collections.") ## Request body for POST [Wave Collection Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_input.htm "A collection of Analytics resources.") ## Response body for POST [Wave Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection.htm "A collection of Analytics resources.") # Collections Resource Returns, updates, or deletes a collection. Each collection contains Analytics resource items. ## Resource URL /analytics/collections/ /wave/collections/ ## Formats JSON ## Available Version 52.0 ## HTTP Methods GET PATCH DELETE ## Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | collectionId | String | The ID of the collection. | Required | 52.0 | ## Response body for GET [Wave Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection.htm "A collection of Analytics resources.") ## Request body for PATCH [Wave Collection Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_input.htm "A collection of Analytics resources.") ## Response body for PATCH [Wave Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection.htm "A collection of Analytics resources.") # Compact Form Column A compact form column. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field | Object | The compact form column field. | Small, 48.0 | 48.0 | | formula | String | The compact form column formula. | Small, 48.0 | 48.0 | | name | String | The name of the compact form column. | Small, 48.0 | 48.0 | # Compact Form Filter A compact form filter. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | booleanFilterLogic | String | The boolean filter logic. | Small, 49.0 | 49.0 | | filters | Object | The list of filters. | Small, 48.0 | 48.0 | # Compact Form Join A compact form join for q query. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`source`	CompactFormJoinObject	The source object for compact form join.	Small, 58.0	58.0
`target`	CompactFormJoinObject	The target object for compact form join.	Small, 58.0	58.0
`type`	ConnectWaveCompactFormJoinTypeEnum	The join type of the compact form. Valid values are: Inner Left Outer Right	Small, 58.0	58.0

# Compact Form Join Object A compact form join object for q query. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | alias | String | The alias for the compact form join object. | Small, 58.0 | 58.0 | | fields | String\[\] | A list of join field for the compact form join object. | Small, 59.0 | 59.0 | | name | String | The name for the compact form join object. | Small, 58.0 | 58.0 | # Compact Form Source A compact form source for a query. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`cogroupType`	ConnectWaveCompactFormCogroupTypeEnum	The join type of the compact form. Valid values are: Anti Inner Left Outer Right Semi	Small, 48.0	48.0
`columns`	CompactFormColumn[]	A list of the compact form source columns.	Small, 48.0	48.0
`filters`	Object	The compact form source column filters.	Small, 52.0	52.0
`groups`	Object	The compact form source groups.	Small, 48.0	48.0
`joins`	CompactFormJoin[]	A list of the compact form source joins.	Small, 58.0	58.0
`name`	String	The compact form source name.	Small, 48.0	48.0

# Component Saved View A state for the saved view of an Analytics component. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | pageId | String | The ID of the component page for the saved view. | Small, 51.0 | 51.0 | | state | [ComponentSavedViewState](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_component_saved_view_state.htm "A state for the saved view of an Analytics component.") | The state for the saved view of the component. | Big, 51.0 | 51.0 | # Component Saved View Input The saved view for an Analytics component. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | pageId | String | The id of the component page the saved view persists. | Required | 51.0 | | state | Map | The state of the component saved view, including selections and filters applied directly to the component. | Required | 51.0 | # Component Saved View State A state for the saved view of an Analytics component. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | cdpObjects | Map | Map of the fully qualified cdpObject names to cdpObject state. | Small, 55.0 | 55.0 | | datasets | Map | Map of the fully qualified dataset names to dataset state. | Small, 42.0 | 42.0 | | sObjects | Map | Map of the fully qualified sObject names to sObject state. | Small, 55.0 | 55.0 | | steps | Map | Map of the step ids to step state. | Small, 42.0 | 42.0 | # Component Saved View State Input The state for an Analytics component saved view. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cdpObjects | Map | Map of fully qualified cdpObject names to cdpObject state. | Required | 55.0 | | datasets | Map | Map of fully qualified dataset names to dataset state. | Required | 51.0 | | sObjects | Map | Map of fully qualified sObject names to sObject state. | Required | 55.0 | | steps | Map | Map of step ids to step state. | Required | 51.0 | # Conditional Formatting Property The extended metadata (Xmd) for a property in the conditional formatting for an Analytics dataset dimension or measure. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`parameters`	Object	The parameters for different formatting types.	Small, 42.0	42.0
`referenceField`	String	The reference field the conditional formatting is based on, if any.	Small, 42,0	42.0
`type`	ConnectWaveConditionalFormattingTypeEnum	The conditional formatting type. Valid values are: `Categories` `Gradient` `Multiple` `Raw` `Single` `Static`	Small 42.0	42.0

# Conditional Formatting Property Input A property for conditional formatting of Xmd dimensions and measures. ## Properties

Property Name	Type	Description	Required or Optional	Available Version
`parameters`	Object	The parameters for different types of formatting.	Required	42.0
`referenceField`	String	The reference field to base the formatting on.	Optional	42.0
`type`	ConnectWaveConditionalFormattingTypeEnum	The conditional formatting type. Valid values are: `Categories` `Gradient` `Multiple` `Raw` `Single` `Static`	Required	42.0

# Configuration Page Layout The configuration page layout for a template configuration wizard page. ## Properties Inherits properities from [Page Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_layout.htm "The page layout definition for an Analytics template.").

Property Name	Type	Description	Filter Group and Version	Available Version
`layout`	Layout	The layout for the page. Valid values are: CustomComponentLayout SingleColumnLayout TwoColumnLayout	Small, 56.0	56.0

# Configure Your Trailhead Org To configure your Trailhead org, set up Cross-Origin Resource Sharing (CORS) and a connected app. Set up CORS and your connected app. ## Set Up CORS CORS allows code running in a web browser to communicate with Salesforce from a specific origin. To add the URL patterns for Postman: 1. In your Trailhead Playground, from Setup, in the Quick Find box, enter cors, and then select **CORS**. 2. In the Allowed Origins List, click **New**. 3. Enter https://\*.postman.com as the Origin URL Pattern. 4. Save your work. 5. Click **New**, and enter https://\*.postman.com as the Origin URL Pattern. 6. Save your work again. ## Set Up a Connected App To set up your connected app: 1. From Setup, in the Quick Find box, enter App Manager, and then select **New Connected App**. 2. Enter the app name in the Connected App Name field, and enter your email address in the Contact Email field. 3. Under API Heading, select **Enable OAuth Settings**. 4. Enter the callback URL: https://oauth.pstmn.io/v1/callback. 5. Select **Use digital signatures**. 6. Select **Choose File**, and then select the host.crt file from your private public keypair. 7. Under Selected OAuth Scopes, select the **Manage user data via APIs (api)** and the **Perform requests at any time (refresh\_token, offline\_access)** scopes. 8. Deselect **Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flow**. 9. Save your work. 10. On the connected app details page, click the **Manage Consumer Details** button. This action triggers a verification code sent to your email. Then you can see the Key and Secret values. 11. At the top of the new connected app, click **Manage**, and then select **Edit Policies**. 12. Under IP Relaxation, select **Relax IP restrictions**, and save your changes. # Connect REST API Authorization Connect REST API uses OAuth to securely identify your application before connecting to Salesforce. ## OAuth and Connect REST API For current OAuth information, see [OAuth and Connect REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_using_oauth.htm) in the Connect REST API developer guide. ## More Resources Salesforce offers the following resources to help you navigate connected apps and OAuth: - _Salesforce Help_: [Connected Apps](https://help.salesforce.com/articleView?id=connected_app_overview.htm&language=en_US "HTML (New Window)") - _Salesforce Help_: [Authorize Apps with OAuth](https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&language=en_US "HTML (New Window)") - _Salesforce Help_: [OpenID Connect Token Introspection](https://help.salesforce.com/articleView?id=remoteaccess_oidc_token_introspection_endpoint.htm&language=en_US "HTML (New Window)") - _Trailhead_: [Build Integrations Using Connected Apps](https://trailhead.salesforce.com/en/content/learn/trails/build-integrations-using-connected-apps "HTML (New Window)") # Connection Property A property used to connect to an Analytics data connector. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`conditions`	PropertyCondition[]	A list of conditions for the connection property.	Small, 66.0	66.0
`dataType`	ConnectWaveConnPropertyTypeEnum	The field type of the connection property. Valid values are: `Boolean` `Numeric` `Select` `Text`	Small, 39.0	39.0
`defaultValue`	Object	The default value of the connection property.	Small, 39.0	39.0
`isEncrypted`	Boolean	Indicates whether the connection property is encrypted (`true`) or not (`false`).	Small, 39.0	39.0
`isRequired`	Boolean	Indicates whether the connection property is required (`true`) or not (`false`).	Small, 39.0	39.0
`label`	String	The label of the connection property.	Small, 39.0	39.0
`maxLength`	Integer	The maximum length of the connection property.	Small, 39.0	39.0
`name`	String	The name of the connection property.	Small, 39.0	39.0
`options`	PropertyOption[]	A list of select options for the connection property.	Small, 66.0	66.0

# Connection Property Value A connection property name and value pair. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the connection property. | Small, 39.0 | 39.0 | | value | Object | The value of the connection property. | Small, 39.0 | 39.0 | # Connector Type The connector type of an Analytics template variable. ## Properties Inherits properties from [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | String\[\] | The restricted list of enumerated connector values. | Small, 48.0 | 48.0 | # Connectors Stats The statistics information for the Analytics connectors. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | currentParquetOptInObjects | Integer | The current amount of objects using optimized data sync to Parquet. | Small, 65.0 | 65.0 | | maximumParquetOptInObjects | Integer | The maximum allowed objects using optimized data sync to Parquet. | Small, 65.0 | 65.0 | # Constant Input The definition of a constant for JSON transformation rules. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | A name of the constant. | Required | 43.0 | | value | Object | A value of the constant. | Required | 43.0 | # Contextual Source Asset A contextual representation of an Analytics dashboard. ## Properties ContextualSourceAsset inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear in ContextualSourceAsset alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dashboardId | ID | The 18 character ID of the dashboard. | Small, 57.0 | 57.0 | | externalState | [DashboardSavedViewState](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_step_state.htm "A step state for the saved view of an Analytics dashboard.") | The external state of the contextual asset. | Small, 57.0 | 57.0 | | locations | [DashboardContextLocation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_context_location.htm "A location of an Analytics embedded dashboard.")\[\] | A list of the location for the contextual asset. | Small, 57.0 | 57.0 | | savedView | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The saved view of the dashboard. | Small, 57.0 | 57.0 | # Coverage Job The output of a user coverage request. Properties CoverageJob inherits properties from the abstract [BaseWaveAssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear in CoverageJob alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | message | String | The error or warning message that occurred during the job run. | Small, 50.0 | 50.0 | | object | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The object name for the job. | Small, 45.0 | 45.0 | | status | CoverageJobStatusEnum | The status of the job. | Small, 45.0 | 45.0 | | userCoverage | String | The user coverage calculated by this job. | Small, 45.0 | 45.0 | # CRM Analytics Connect REST API Release Notes Use the Salesforce Release Notes to learn about the most recent updates and changes to the CRM Analytics Connect REST API. For new and changed CRM Analytics Connect REST resources and request and response bodies see [CRM Analytics](https://help.salesforce.com/s/articleView?id=release-notes.rn_bi_analytics_cloud.htm&language=en_US) in the Salesforce Release Notes. ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If the API: New and Changed Items section in the Salesforce Release Notes isn’t present, there aren’t any updates for that release. # CRM Analytics Lightning Web Components Use CRM Analytics Lightning Web Components to retrieve data and metadata for CRM Analytics assets, execute queries, and schedule data syncs for recipes and dataflows. The lightning/analyticsWaveApi module provides wire adapters and JavaScript functions built on top of the CRM Analytics REST API. Use these wire adapters and functions to work with CRM Analytics data and metadata. ![Important](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note_important.png) #### Important Not all API endpoints have a corresponding wire adapter or function. Assets such as recipes require the recipe editor UI for creation and aren’t supported in the lightning/analyticsWaveApi module. ## Wire Adapters getActions Retrieves a collection of Salesforce actions available for the specified Analytics user. For more information on syntax and usage, see the [getActions](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-actions.html) reference in the Lightning Web Components Developer Guide. getAnalyticsLimits Retrieves the Analytics limits for CRM Analytics. For more information on syntax and usage, see the [getAnalyticsLimits](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-analytics-limits.html) reference in the Lightning Web Components Developer Guide. getDataConnector Retrieves a specific CRM Analytics data connector by ID or developer name. For more information on syntax and usage, see the [getDataConnector](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector.html) reference in the Lightning Web Components Developer Guide. getDataConnectors Retrieves a collection of CRM Analytics data connectors. For more information on syntax and usage, see the [getDataConnectors](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connectors.html) reference in the Lightning Web Components Developer Guide. getDataConnectorSourceFields Retrieves a collection of source fields for a source object used by a CRM Analytics data connector. For more information on syntax and usage, see the [getDataConnectorSourceFields](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connectorsource-fields.html) reference in the Lightning Web Components Developer Guide. getDataConnectorSourceObject Retrieves a source object used by a CRM Analytics data connector. For more information on syntax and usage, see the [getDataConnectorSourceObject](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-source-object.html) reference in the Lightning Web Components Developer Guide. getDataConnectorSourceObjectDataPreviewWithFields Retrieves the fields for a data preview for a source object used by a CRM Analytics data connector. For more information on syntax and usage, see the [getDataConnectorSourceObjectDataPreviewWithFields](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-source-object-data-previewwithfields.html) reference in the Lightning Web Components Developer Guide. getDataConnectorStatus Retrieves the status for a specific CRM Analytics data connector by ID or developer name. For more information on syntax and usage, see the [getDataConnectorStatus](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-status.html) reference in the Lightning Web Components Developer Guide. getDataConnectorTypes Retrieves the collection of CRM Analytics data connector types. For more information on syntax and usage, see the [getDataConnectorTypes](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-types.html) reference in the Lightning Web Components Developer Guide. getDataflowJob Retrieves a specific CRM Analytics dataflow job. For more information on syntax and usage, see the [getDataflowJob](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflow-job.html) reference in the Lightning Web Components Developer Guide. getDataflowJobs Retrieves a collection of CRM Analytics dataflow jobs. For more information on syntax and usage, see the [getDataflowJobs](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflow-jobs.html) reference in the Lightning Web Components Developer Guide. getDataflowJobNode Retrieves a specific CRM Analytics dataflow job node for a recipe or dataflow. For more information on syntax and usage, see the [getDataflowJobNode](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflow-job-node.html) reference in the Lightning Web Components Developer Guide. getDataflowJobNodes Retrieves a collection of CRM Analytics dataflow job nodes for a recipe or dataflow. For more information on syntax and usage, see the [getDataflowJobNodes](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflow-job-nodes.html) reference in the Lightning Web Components Developer Guide. getDataflows Retrieves a collection of CRM Analytics dataflows. For more information on syntax and usage, see the [getDataflows](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflows.html) reference in the Lightning Web Components Developer Guide. getDataset Retrieves a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the [getDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataset.html) reference in the Lightning Web Components Developer Guide. getDatasets Retrieves a collection of CRM Analytics datasets. For more information on syntax and usage, see the [getDatasets](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-datasets.html) reference in the Lightning Web Components Developer Guide. getDatasetVersion Retrieves a specific CRM Analytics dataset version by ID or developer name. For more information on syntax and usage, see the [getDatasetVersion](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataset-version.html) reference in the Lightning Web Components Developer Guide. getDatasetVersions Retrieves a collection of versions for a CRM Analytics dataset. For more information on syntax and usage, see the [getDatasetVersions](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataset-versions.html) reference in the Lightning Web Components Developer Guide. getDependencies Retrieves a collection of dependencies for a CRM Analytics asset. For more information on syntax and usage, see the [getDependencies](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dependencies.html) reference in the Lightning Web Components Developer Guide. getRecipe Retrieves a specific CRM Analytics recipe by ID. For more information on syntax and usage, see the [getRecipe](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-recipe.html) reference in the Lightning Web Components Developer Guide. getRecipes Retrieves a collection of CRM Analytics recipes. For more information on syntax and usage, see the [getRecipes](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-recipes.html) reference in the Lightning Web Components Developer Guide. getReplicatedDataset Retrieves a specific CRM Analytics replicated dataset by ID, also known as a connected object. For more information on syntax and usage, see the [getReplicatedDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-replicated-dataset.html) reference in the Lightning Web Components Developer Guide. getReplicatedDatasets Retrieves a collection of CRM Analytics replicated datasets, also known as connected objects. For more information on syntax and usage, see the [getReplicatedDatasets](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-replicated-datasets.html) reference in the Lightning Web Components Developer Guide. getReplicatedFields Retrieves a collection of fields belonging to a CRM Analytics replicated dataset, also known as connected object. For more information on syntax and usage, see the [getReplicatedFields](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-replicated-fields.html) reference in the Lightning Web Components Developer Guide. getSchedule Retrieves a schedule for a CRM Analytics recipe, dataflow, or data sync. For more information on syntax and usage, see the [getSchedule](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-schedule.html) reference in the Lightning Web Components Developer Guide. getSecurityCoverageDatasetVersion Retrieves the security coverage for a specific CRM Analytics dataset version by ID or developer name. For more information on syntax and usage, see the [getSecurityCoverageDatasetVersion](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-security-coverage-dataset-version.html) reference in the Lightning Web Components Developer Guide. getStories Retrieves a collection of Einstein Discovery stories. For more information on syntax and usage, see the [getStories](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-stories.html) reference in the Lightning Web Components Developer Guide. getWaveFolder Retrieves a specific CRM Analytics app or folder. For more information on syntax and usage, see the [getWaveFolder](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-folder.html) reference in the Lightning Web Components Developer Guide. getWaveFolders Retrieves a collection of CRM Analytics apps or folders. For more information on syntax and usage, see the [getWaveFolders](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-folders.html) reference in the Lightning Web Components Developer Guide. getWaveTemplate Retrieves a CRM Analytics template by ID or API name. For more information on syntax and usage, see the [getWaveTemplate](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-template.html) reference in the Lightning Web Components Developer Guide. getWaveTemplateConfig Retrieves the configuration for a CRM Analytics template by ID or API name. For more information on syntax and usage, see the [getWaveTemplateConfig](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-template-config.html) reference in the Lightning Web Components Developer Guide. getWaveTemplateReleaseNotes Retrieves the release notes for a CRM Analytics template by ID or API name. For more information on syntax and usage, see the [getWaveTemplateReleaseNotes](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-template-release-notes.html) reference in the Lightning Web Components Developer Guide. getWaveTemplates Retrieves a collection of CRM Analytics templates. For more information on syntax and usage, see the [getWaveTemplates](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-templates.html) reference in the Lightning Web Components Developer Guide. getXmd Retrieves a specific CRM Analytics extended metadata type (Xmd) for a version of a dataset. For more information on syntax and usage, see the [getXmd](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-xmd.html) reference in the Lightning Web Components Developer Guide. ## Functions createDataConnector Creates an instance of a CRM Analytics connector to connect to data in your Salesforce orgs, apps, data warehouses, and database services. For more information on syntax and usage, see the [createDataConnector](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-data-connector.html) reference in the Lightning Web Components Developer Guide. createDataflowJob Creates a CRM Analytics dataflow job, which is the equivalent of clicking **Run Now** for a data prep recipe, a data sync, or a dataflow in the CRM Analytics Data Manager UI. For more information on syntax and usage, see the [createDataflowJob](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-dataflow-job.html) reference in the Lightning Web Components Developer Guide. createDataset Creates a dataset. For more information on syntax and usage, see the [createDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-dataset.html) reference in the Lightning Web Components Developer Guide. createDatasetVersion Creates a version for a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the [createDatasetVersion](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-dataset-version.html) reference in the Lightning Web Components Developer Guide. createReplicatedDataset Creates a CRM Analytics replicated dataset, also known as a connected object. For more information on syntax and usage, see the [createReplicatedDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-replicated-dataset.html) reference in the Lightning Web Components Developer Guide. deleteDataConnector Deletes a specific CRM Analytics connector by ID or developer name. For more information on syntax and usage, see the [deleteDataConnector](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-data-connector.html) reference in the Lightning Web Components Developer Guide. deleteDataset Deletes a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the [deleteDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-dataset.html) reference in the Lightning Web Components Developer Guide. deleteRecipe Deletes a specific CRM Analytics recipe by ID. For more information on syntax and usage, see the [deleteRecipe](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-recipe.html) reference in the Lightning Web Components Developer Guide. deleteReplicatedDataset Deletes a specific CRM Analytics replicated dataset by ID. For more information on syntax and usage, see the [deleteReplicatedDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-replicated-dataset.html) reference in the Lightning Web Components Developer Guide. deleteWaveFolder Deletes a specific CRM Analytics app or folder by ID. For more information on syntax and usage, see the [deleteWaveFolder](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-wave-folder.html) reference in the Lightning Web Components Developer Guide. executeQuery Executes a CRM Analytics query written in Salesforce Analytics Query Language (SAQL) or standard SQL. For more information on syntax and usage, see the [executeQuery](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-execute-query.html) reference in the Lightning Web Components Developer Guide. ingestDataConnector Triggers the CRM Analytics to run a data sync. For more information on syntax and usage, see the [ingestDataConnector](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-ingest-data-connector.html) reference in the Lightning Web Components Developer Guide. postWaveFolders Creates a CRM Analytics app or folder by ID. For more information on syntax and usage, see the [postWaveFolders](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-post-wave-folders.html) reference in the Lightning Web Components Developer Guide. updateDataConnector Updates a CRM Analytics data connector. For more information on syntax and usage, see the [updateDataConnector](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-data-connector.html) reference in the Lightning Web Components Developer Guide. updateDataflowJob Updates a CRM Analytics dataflow job, which is the equivalent of clicking **Stop** for a data prep recipe, a data sync, or a dataflow in the CRM Analytics Data Manager UI. For more information on syntax and usage, see the [updateDataflowJob](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-dataflow-job.html) reference in the Lightning Web Components Developer Guide. updateDataset Updates a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the [updateDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-dataset.html) reference in the Lightning Web Components Developer Guide. updateDatasetVersion Updates a specific CRM Analytics dataset version by ID or developer name. For more information on syntax and usage, see the [updateDatasetVersion](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-dataset-version.html) reference in the Lightning Web Components Developer Guide. updatePartialWaveFolder Performs a partial update for a CRM Analytics app or folder by ID. For more information on syntax and usage, see the [updatePartialWaveFolder](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-partial-wave-folder.html) reference in the Lightning Web Components Developer Guide. updateRecipe Updates a CRM Analytics recipe. For more information on syntax and usage, see the [updateRecipe](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-recipe.html) reference in the Lightning Web Components Developer Guide. updateReplicatedDataset Updates a CRM Analytics replicated dataset by ID. For more information on syntax and usage, see the [updateReplicatedDataset](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-replicated-dataset.html) reference in the Lightning Web Components Developer Guide. updateReplicatedFields Updates the collection of fields for a CRM Analytics replicated dataset by ID. For more information on syntax and usage, see the [updateReplicatedFields](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-replicated-dataset-fields.html) reference in the Lightning Web Components Developer Guide. updateSchedule Updates the schedule for a CRM Analytics data prep recipe, data sync, or dataflow. For more information on syntax and usage, see the [updateSchedule](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-schedule.html) reference in the Lightning Web Components Developer Guide. updateXmd Updates the user Xmd for a CRM Analytics dataset. For more information on syntax and usage, see the [updateXmd](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-xmd.html) reference in the Lightning Web Components Developer Guide. updateWaveFolder Updates a CRM Analytics app or folder by ID. For more information on syntax and usage, see the [updateWaveFolder](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-wave-folder.html) reference in the Lightning Web Components Developer Guide. validateWaveTemplate Validates a CRM Analytics template for org readiness. For more information on syntax and usage, see the [valildateWaveTemplate](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-validate-wave-template.xmd.html) reference in the Lightning Web Components Developer Guide. # CRM Analytics REST API Examples Use CRM Analytics REST API examples to perform tasks. While using the CRM Analytics REST API, keep this in mind: - Request parameters may be included as part of the CRM Analytics REST API resource URL, for example, /wave/folders?q=searchtext. A request body is a rich input which may be included as part of the request. When accessing a resource, you can use either a request body or request parameters. You cannot use both. - With a request body, use Content-Type: application/json or Content-Type: application/xml. - With request parameters, use Content-Type: application/x-www-form-urlencoded. - To test working example of the CRM Analytics API endpoints and view payload information, see the[CRM Analytics Connect API Collection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/collection/12721794-da62aee9-0da3-4f68-9083-1e10118bc2dd?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response.") - **[Query CRM Analytics Data with the Query API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_api_query_data.htm)** Use the CRM Analytics REST API to directly query analytics data using SAQL or SQL queries. - **[Backup and Restore Previous Versions of CRM Analytics Assets with History API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_asset_history.htm)** When you edit CRM Analytics dashboards, lenses, recipes, and dataflows, CRM Analytics backs them up automatically. When you save a new version of an asset, CRM Analytics creates a snapshot of it. You can then preview snapshots and revert to previous versions using the REST History API. - **[Run, Schedule, and Sync CRM Analytics Data with REST APIs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm)** You can use the CRM Analytics REST API to automate features, like running and scheduling data syncs, dataflows and recipes. # CRM Analytics REST API Overview You can access CRM Analytics features such as datasets, dashboards, and lenses programmatically using the CRM Analytics REST API. Using the CRM Analytics REST API, you can: - Send queries directly to the CRM Analytics Platform. - Access datasets that have been imported into the CRM Analytics Platform. - Create and retrieve CRM Analytics lenses. - Create, validate, and update templates for CRM Analytics apps. - Back up and restore previous versions of CRM Analytics dashboards, lenses, and dataflows. See [Backup and Restore Previous Versions of CRM Analytics Assets with History API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_asset_history.htm "When you edit CRM Analytics dashboards, lenses, recipes, and dataflows, CRM Analytics backs them up automatically. When you save a new version of an asset, CRM Analytics creates a snapshot of it. You can then preview snapshots and revert to previous versions using the REST History API."). - Run, schedule, and sync CRM Analytics dataflows, recipes, and connections. See [Run, Schedule, and Sync CRM Analytics Data with REST APIs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm "You can use the CRM Analytics REST API to automate features, like running and scheduling data syncs, dataflows and recipes.") - Retrieve a list of dataflow job nodes and details for each individual node. - Access XMD information. - Create and retrieve standard datasets. - Retrieve a list of dataset versions. - Convert Data 360 data model objects to datasets. - Create and retrieve CRM Analytics apps. - Create, update, and retrieve CRM Analytics dashboards. - Retrieve a list of dependencies for an application. - Determine what features are available to the user. - Work with and schedule Trend in CRM Analytics report snapshots. - Manipulate synced datasets, also known as connected objects. - Get, add, update, and delete ‘eclair’ geo map charts. - Work with data connectors. - Retrieve or update recipe metadata. See [Build, Manage, Schedule, and Run Recipes with REST APIs](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_build_manage_recipes.htm) - Discover whether objects and particular dataset versions have support for sharing inheritance. - Create, update, and retrieve auto-install requests for embedded CRM Analytics applications. - Create and retrieve collections of CRM Analytics resources. - Create, update, and retrieve email subscriptions for updates on important analytics. - Create and retrieve watchlists to track important metrics. - Test JSON template transformation rules. - Retirive analytics assets and asset files. - Download a CRM Analytics dashboard or lens or a Lightning Experience dashboard or report as an image or PDF. For more information see, the [Analytics Download](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_analytics.meta/api_analytics/analytics_api_download_reference_resource.htm) resource in the Salesforce Reports and Dashboards REST API Developer Guide. - Get Einstein Discovery predictions on Salesforce objects and more via the smartdatadiscovery API. For more information, see the [Einstein Discovery REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_rest_sdd_overview.htm). - Access Search Insights features via the autonomous-analtyics API. For more information, see the [Search Insights REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest_aa.meta/bi_dev_guide_rest_aa/bi_rest_aa_overview.htm). The CRM Analytics REST API is based on the Connect REST API and follows its conventions. For more information about the Connect REST API, see the [Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm). - **[CRM Analytics Connect REST API Release Notes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_releasenotes.htm)** Use the Salesforce Release Notes to learn about the most recent updates and changes to the CRM Analytics Connect REST API. - **[Connect REST API Authorization](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_authentication.htm)** Connect REST API uses OAuth to securely identify your application before connecting to Salesforce. - **[CRM Analytics Lightning Web Components](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_lwc.htm)** Use CRM Analytics Lightning Web Components to retrieve data and metadata for CRM Analytics assets, execute queries, and schedule data syncs for recipes and dataflows. - **[API End-of-Life Policy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_api_rest_eol.htm)** Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to mature and improve the quality and performance of the API, versions that are more than three years old might cease to be supported. # CRM Analytics REST API Request Bodies To perform a POST, PATCH, or PUT request, pass query parameters or create a request body formatted in either XML or JSON. This chapter lists the request bodies. The query parameters are listed with each resource. To create a JSON request body, specify the properties of the request body in JSON format. This is an example of a Comment request body. { "body" : "Let's look for a new solution." } If a request body is top-level, it has a root XML tag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag. This is the same Analytics request body in XML format: Let's look for a new solution. - **[Action Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_action_input.htm)** The action for a rule or macro to perform during a JSON transformation. - **[Advanced Property Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_advanced_property_value_input.htm)** An advanced property name and value pair. - **[Analytics App Setting Collection Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_analytics_app_setting_collection_input.htm)** The collection of Analytics app settings. - **[Analytics App Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_analytics_app_setting_input.htm)** A setting for an Analytics app. - **[Analytics Asset Collection Query Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_analytics_asset_collection_query_input.htm)** The query parameters used to request a collection of Analytics assets. - **[Analytics Asset Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_analytics_asset_filter_input.htm)** A filter for the Analtyics asset collection parameters. - **[Annotation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_annotation_input.htm)** An Analytics annotation. - **[Asset Archival Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_archival_input.htm)** The assets to archive or restore, and the target archival state. - **[Asset Archival Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_archival_reference_input.htm)** A reference to a single CRM Analytics asset to archive or restore. - **[Asset Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm)** An Analytics asset reference. - **[Asset Revert History Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_revert_history_input.htm)** The Analytics asset history to use for a revert request. - **[Auto-Install App Configuration Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_app_config_input.htm)** The configuration for an auto-install app. - **[Auto-Install Configuration Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_config_input.htm)** The configuration for a auto-install app. - **[Auto-Install Request Insert Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_request_insert_input.htm)** The insert for an auto-install request. - **[Auto-Install Request Update Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_auto_install_request_update_input.htm)** The update for an auto-install request. - **[Base Asset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_asset_input.htm)** The base Analytics asset input. - **[Base Asset Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_asset_reference_input.htm)** The base Analytics asset. - **[Base Auto-Install Request Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_auto_install_request_input.htm)** The base auto-install request input. - **[Base Notification Action Configuration Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_notification_action_configuration_input.htm)** The base Analytics notification action configuration. - **[Base Subscription Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_subscription_input.htm)** The base subscription request input. - **[Base Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_wave_folder_input.htm)** The base Analytics folder asset. - **[Collaboration Room Notification Recipient Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_collaboration_room_notification_recipient_input.htm)** The Slack recipient of a notification. - **[Collection Subscription Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_collection_subscription_source_input.htm)** The collection subscription source. - **[Component Saved View Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_component_saved_view_input.htm)** The saved view for an Analytics component. - **[Component Saved View State Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_component_saved_view_state_input.htm)** The state for an Analytics component saved view. - **[Conditional Formatting Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_conditional_formatting_property_input.htm)** A property for conditional formatting of Xmd dimensions and measures. - **[Constant Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_constant_input.htm)** The definition of a constant for JSON transformation rules. - **[Daily Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_daily_schedule_input.htm)** Specify a daily schedule for an Analytics asset. - **[Daily Scheduled Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_daily_scheduled_item_input.htm)** The daily schedule for a data refresh. - **[Dashboard Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_input.htm)** An Analytics dashboard. - **[Dashboard Saved View Data Source State Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_data_source_state_input.htm)** The data source state for an Analytics dashboard saved view. - **[Dashboard Saved View Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_filter_input.htm)** A filter for an Analytics dashboard saved view. - **[Dashboard Saved View Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_input.htm)** A saved view for an Analytics dashboard. - **[Dashboard Saved View State Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_state_input.htm)** The state for an Analytics dashboard saved view. - **[Dashboard Saved View Step Metadata Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_step_metadata_input.htm)** The step metadata for an Analytics dashboard saved view. - **[Dashboard Saved View Step State Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_step_state_input.htm)** The step state for an Analytics dashboard saved view. - **[Dashboard Subscription Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_subscription_source_input.htm)** The dashboard subscription source. - **[Dashboard Widget Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_widget_item_input.htm)** The base dashboard widget item. - **[Data Cloud Extended Metadata Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_cloud_extended_metadata_input.htm)** The extended metadata (Xmd) for a Data 360 object data source for Analytics. - **[Data Cloud Field Extended Metadata Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_cloud_field_extended_metadata_input.htm)** The extended metadata (Xmd) for a field in Data 360 object. - **[Data Cloud Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_cloud_field_value_input.htm)** A customized display value for a data object field. - **[Data Connector Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_connector_input.htm)** An Analytics data connector. - **[Data Connector Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_connector_property_input.htm)** A property for an Analytics data connector. - **[Dataflow Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataflow_input.htm)** An Analytics dataflow. - **[Dataflow Job Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataflow_job_input.htm)** An Analytics dataflow job. - **[Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataset_input.htm)** An Analytics dataset. - **[Dataset Version Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataset_version_input.htm)** A specific version of an Analytics dataset. - **[Event Based Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_event_based_schedule_input.htm)** Specify an event-driven schedule for an Analytics asset. - **[Featured Assets Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_featured_assets_input.htm)** A feaatured assets for an Analytics app. - **[Geo Data Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_geo_data_input.htm)** The geo data used by a map. - **[Hourly Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_hourly_schedule_input.htm)** Specify a sub-daily schedule for an Analytics asset. - **[Json Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_json_transformation_input.htm)** The JSON request to perform transformation rules on. - **[Lens Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_lens_input.htm)** An Analytics lens. - **[Lens State Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_lens_state_input.htm)** The state for an Analytics lens. - **[License Attributes Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_license_attributes_input.htm)** The Analytics license attributes. - **[Live Connection Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_live_connection_input.htm)** The connection details of an Analytics live dataset. - **[Macro Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_macro_input.htm)** A macro to use for a JSON transformation rule. - **[Map Bounding Box Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_map_bounding_box_input.htm)** A bounding box of a map.. - **[Map Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_map_input.htm)** A map for an Eclair chart. - **[Mapped SDM Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_mapped_sdm_input.htm)** A mapped Tableau Next semantic model. - **[Minutely Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_minutely_schedule_input.htm)** Specify a sub-hourly schedule for an Analytics asset. - **[Monthly Relative Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_monthly_relative_schedule_input.htm)** Specify a monthly schedule for an Analytics asset where the day are relative to their location in the week. - **[Monthly Specific Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_monthly_specific_schedule_input.htm)** Specify a monthly schedule for an Analytics asset where the days are fixed by numerical date. - **[Notification Action Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_notification_action_input.htm)** A notification action for an Analytics subscription. - **[Post To Slack Notification Action Configuration Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_post_to_slack_notification_action_configuration_input.htm)** The notification action configuration for posting to Slack. - **[Replicated Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_replicated_dataset_input.htm)** An Analytics replicated dataset, also know as a connected object. - **[Replicated Field Collection Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_replicated_field_collection_input.htm)** A collection of fields for an Analytics replicated dataset, also known as a connected object. - **[Replicated Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_replicated_field_input.htm)** A field for an Analytics replicated dataset, also known as a connected object. - **[Restore Dataset Version Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_restore_dataset_version_input.htm)** A specific version to restore an Analytics dataset to. - **[Rule Definition Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_rule_definition_input.htm)** A rule definition to use for a JSON transformation. - **[Rule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_rule_input.htm)** A rule for a JSON Transformation rule definition. - **[SAQL Query Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_saql_query_input.htm)** An Analytics query written in SAQL or SQL. - **[Schedule Details Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_details_input.htm)** The base Analytics schedule details. - **[Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm)** A schedule on which to execute some type of Analytics asset. - **[Scheduled Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_scheduled_item_input.htm)** The base schedule for a data refresh. - **[Scheduled Time Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_scheduled_time_input.htm)** The base schedule for a data refresh. - **[Scheduled Timezone Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_scheduled_timezone_input.htm)** The information for a schedule time zone. - **[Send To Email Notification Action Configuration Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_send_to_email_notification_action_configuration_input.htm)** The notification action configuration for sending an email. - **[Slack Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_slack_reference_input.htm)** The reference for a Slack entity. - **[Source Details Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_details_input.htm)** The abstract source details for a subscription. - **[Source Object Data Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_object_data_input.htm)** The request to retrieve data from a source object given a list of fields and advanced properties. - **[Subscription Daily Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_daily_schedule_input.htm)** The daily schedule on which to execute an Analytics subscription. - **[Subscription Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_input.htm)** An Analytics subscription. - **[Subscription Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_schedule_input.htm)** An Analytics subscription input. - **[Subscription Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_source_input.htm)** The subscription source. - **[Subscription Weekly Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_weekly_schedule_input.htm)** The weekly schedule on which to execute an Analytics subscription. - **[Subscription Widget Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_widget_input.htm)** An Analytics widget subscription inherits properties from the base Dashboard Widget Item Input. - **[Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_input.htm)** An Analytics template. - **[Template Options Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_options_input.htm)** The template options used to upgrade a templated Analytics app. - **[Template Validate Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_validate_input.htm)** The input to validate an Analytics template. - **[Time Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_time_input.htm)** The time at which something should happen, usually in relation to an Analytics schedule. - **[Trended Report Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_trended_report_input.htm)** An Analytics trended report. - **[Typed Asset Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_typed_asset_reference_input.htm)** A typed Analytics asset reference. - **[Visual Parameters Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_visual_parameters_input.htm)** A visual parameters for an Analytics watchlist item. - **[Watchlist Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_input.htm)** An Analytics watchlist. - **[Watchlist Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_item_input.htm)** An Analytics watchlist item. - **[Watchlist Item Metadata Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_item_metadata_input.htm)** The metadata for an Analytics watchlist item. - **[Watchlist Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_schedule_input.htm)** An Analytics watchlist schedule. - **[Wave Collection Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_input.htm)** A collection of Analytics resources. - **[Wave Collection Item Bulk Add Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_bulk_add_input.htm)** Bulk items to add to a collection of Analytics resources. - **[Wave Collection Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_input.htm)** An item in a collection of Analytics resources. - **[Wave Collection Item List Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_list_input.htm)** A list of items in a collection of Analytics resources. - **[Wave Collection Pin Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_pin_input.htm)** The pinning rules for an Analytics collection. - **[Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_input.htm)** An Analytics folder. This implements BaseWaveFolderInput. - **[Wave Folder Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_schedule_input.htm)** An Analytics folder schedule. - **[Wave Folder Share Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_share_input.htm)** An Analytics folder sharing rule. - **[Wave Folder Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_template_input.htm)** A templated Analytics folder. This implements BaseWaveFolderInput. - **[Weekly Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_weekly_schedule_input.htm)** Specify a weekly schedule for an Analytics asset. - **[Weekly Scheduled Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_weekly_scheduled_item_input.htm)** The weekly schedule for a data refresh. - **[Widget Subscription Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_widget_subscription_source_input.htm)** The widget subscription source. - **[Base Xmd Dimension Custom Action Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_dimension_custom_action_input.htm)** The base custon action for an Xmd dimension. - **[Base Xmd Dimension Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_dimension_input.htm)** The base Xmd dimension for dimensions and derived dimensions. - **[Base Xmd Measure Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_measure_input.htm)** The base Xmd measure for measures and derived measures. - **[Xmd Currency Settings Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_currency_settings_input.htm)** The extended metadata (Xmd) for currency settings of a currency field. - **[Xmd Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dataset_input.htm)** The extended metadata (Xmd) for an Analytics dataset. - **[Xmd Date Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_date_field_input.htm)** The extended metadata (Xmd) for the formatting of a date field. - **[Xmd Date Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_date_input.htm)** The extended metadata (Xmd) for a date. - **[Xmd Derived Dimension Custom Action Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_dimension_custom_action_input.htm)** A custom action for an Xmd derived dimension. - **[Xmd Derived Dimension Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_dimension_input.htm)** The extended metadata (Xmd) for a derived dimension in an Analytics dataset. - **[Xmd Derived Dimension Member Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_dimension_member_input.htm)** The extended metadata (Xmd) for a member of a derived dimension in an Analytics dataset. - **[Xmd Derived Dimension Salesforce Action Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_dimension_salesforce_action_input.htm)** The extended metadata (Xmd) for a Saleforce Action for a derived dimension in an Analytics dataset. - **[Xmd Derived Measure Format Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_measure_format_input.htm)** The extended metadata (Xmd) for the format of a derived measure in an Analytics dataset. - **[Xmd Derived Measure Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_measure_input.htm)** The extended metadata (Xmd) for a derived measure in an Analytics dataset. - **[Xmd Dimension Custom Action Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dimension_custom_action_input.htm)** A custom action for an Xmd dimension. - **[Xmd Dimension Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dimension_input.htm)** The extended metadata (Xmd) for a dimension in an Analytics dataset. - **[Xmd Dimension Member Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dimension_member_input.htm)** The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset. - **[Xmd Dimension Salesforce Action Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dimension_salesforce_action_input.htm)** The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset. - **[Xmd Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_input.htm)** The extended metadata (Xmd) for an Analytics dataset version. - **[Xmd Measure Format Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_measure_format_input.htm)** The extended metadata (Xmd) for the format of a measure in an Analytics dataset. - **[Xmd Measure Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_measure_input.htm)** The extended metadata (Xmd) for a measure in an Analytics dataset. - **[Xmd Organization Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_organization_input.htm)** The extended metadata (Xmd) for an organization in an Analytics dataset. # CRM Analytics REST API Resources Overview The CRM Analytics REST API provides resources so you can access your CRM Analytics data. All CRM 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/v53.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/v53.0/wave ## Org and Object Identifiers Id fields in Salesforce, and in the CRM Analytics UI, are typically 15-character, base-62, case-sensitive strings. This is true of JSON XMD too. However, many Salesforce APIs, including the CRM Analytics REST API, use 18-character, case-insensitive strings—for example, the Id property of the Dataset resource/wave/datasets/. The last 3 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-insensitive references. To convert an 18-character Id back to a 15-character ID, simply remove the last 3 characters. ## General Resources General resources for CRM Analytics are covered here, while specific features like dashboards and recipes have their own sections.

Resource	Description	Supported HTTP Method	Resource URL
Actions Resource	Returns the Salesforce actions available for the user in Analytics.	GET	`/wave`
Dependencies Resource	Returns the dependencies for an asset.	GET	`/wave/dependencies/<folderId>`
Feature Configuration Resource	Returns the CRM Analytics features that are available to a user.	GET	`/wave/config/features`
JsonXform Transformation Resource	Performs a JSON transformation.	POST	`/jsonxform/transformation`
Limits Resource	Get the Analytics limits for the Salesforce org.	GET	`/wave/limits`
Query Resource	Executes a query written in Salesforce Analytics Query Language (SAQL).	POST	`/wave/query`
Security Resources	Discover whether objects and particular dataset versions have support for sharing inheritance.	GET	`/wave/security/coverage/datasets/<datasetIdOrApiName>/versions/<versionId>` `/wave/security/coverage/objects/<objectApiName>`
Unsupported Features Resource	Returns the unsupported features for CRM Analytics in the current datacenter environment.	POST	`/wave/unsupportedFeatures`
Wave Resource	Lists the top-level resources available for CRM Analytics.	GET	`/wave`

## Filtering REST Responses Returns the representation for a CRM Analytics application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), or deletes it (DELETE). In addition to CRM Analytics REST API input parameters, you can use the following Connect REST API input parameters to filter the results returned from a request: filterGroup, external, and internal. For more information, see [Specifying Response Sizes](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_returns_filters.htm) in the Connect REST API Developer Guide. # CRM Analytics REST API Response Bodies The successful execution of a request to a CRM Analytics REST API resource can return a response body in either JSON or XML format. A request to a CRM Analytics REST API resource always returns an HTTP response code, whether the request was successful or not. - **[Abstract Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_abstract_field.htm)** The base definition of a dataset field. - **[Abstract Lint Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_abstract_lint_item.htm)** The base readiness task for an Analytics template. - **[Action Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_action_collection.htm)** A collection of Salesforce actions available to the user. - **[Action](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_action.htm)** A Salesforce action. - **[Advanced Property Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_advanced_property_value.htm)** An advanced property name and value pair. - **[Advanced Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_advanced_property.htm)** An advanced property is a replication property for a data connector source object. - **[Analysis Configuration Outcome](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analysis_configuration_outcome.htm)** The outcome for an Einstein Discovery story. - **[Analytics App Setting Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_app_setting_collection.htm)** The collection of Analytics app settings. - **[Analytics App Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_app_setting.htm)** A setting for an Analytics app. - **[Analytics Asset Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_asset_collection.htm)** A collection of Analytics assets. - **[Analytics Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_asset.htm)** An Analytics asset. - **[Analytics Data Asset File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_data_asset_file.htm)** A file used for preview of an Analytics data asset. - **[Annotation Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_annotation_collection.htm)** A collection of annotations. - **[Annotation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_annotation.htm)** An Analytics annotation. - **[App Details](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_app_details.htm)** The app details for a template configuration wizard page. - **[App Log](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_app_log.htm)** The app log for app creation and updates. - **[Array Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_array_type.htm)** The array type of an Analytics template variable. - **[Asset Archival Item Result](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_archival_item_result.htm)** The archival status and result for a single requested asset. - **[Asset Archival Result](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_archival_result.htm)** The result of an asset archive or restore request. - **[Asset History Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_history_collection.htm)** A collection of asset histories. - **[Asset History](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_history.htm)** The history of an Analytics asset. - **[Asset Publishers Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_publisher_collection.htm)** A collection of asset publishers. - **[Asset Publisher](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_publisher.htm)** The publisher of an Analytics asset. - **[Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm)** An Analytics asset reference. - **[Auto-Install App Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_app_configuration.htm)** The configuration for a auto-install app. - **[Auto-Install Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_configuration.htm)** The configuration for a auto-install request. - **[Auto-Install Request Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_request_collection.htm)** A collection of auto-install requests. - **[Auto-Install Request](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_auto_install_request.htm)** A auto-install request. - **[Base Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_asset_reference.htm)** The base Analytics asset. - **[Base Collection Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_collection.htm)** The base Analytics collection. - **[Base File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_file.htm)** The base Analytics file. - **[Base Notification Action Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_notification_action_configuration.htm)** The base Analytics notification action configuration. - **[Base Object Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm)** The base type for an Analytics template object variable. - **[Base Templated Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_templated_asset.htm)** A base Analytics asset created from a template. - **[Base Wave Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm)** The base Analytics asset. - **[Boolean Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_boolean_type.htm)** The boolean type of an Analytics template variable. - **[Bounding Box](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_bounding_box.htm)** A bounding box of a map. - **[Calculated Insight Field Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_calculated_insight_field_type.htm)** The calculated insight field type of an Analytics template variable. - **[Calculated Insight Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_calculated_insight_type.htm)** The calculated insight type of an Analytics template variable. - **[Collaboration Room Notification Recipient](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_collaboration_room_notification_recipient.htm)** The Slack recipient of a notification. - **[Collection Pin](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_collection_pin.htm)** The pinning rules for an Analytics collection. - **[Collection Subscription Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_collection_subscription_source.htm)** The collection subscription source. - **[Compact Form Column](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_compact_form_column.htm)** A compact form column. - **[Compact Form Filter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_compact_form_filter.htm)** A compact form filter. - **[Compact Form Join Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_compact_form_join_object.htm)** A compact form join object for q query. - **[Compact Form Join](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_compact_form_join.htm)** A compact form join for q query. - **[Compact Form Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_compact_form_source.htm)** A compact form source for a query. - **[Component Saved View State](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_component_saved_view_state.htm)** A state for the saved view of an Analytics component. - **[Component Saved View](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_component_saved_view.htm)** A state for the saved view of an Analytics component. - **[Conditional Formatting Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_conditional_formatting_property.htm)** The extended metadata (Xmd) for a property in the conditional formatting for an Analytics dataset dimension or measure. - **[Configuration Page Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_configuration_page_layout.htm)** The configuration page layout for a template configuration wizard page. - **[Connection Property Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_connection_property_value.htm)** A connection property name and value pair. - **[Connection Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_connection_property.htm)** A property used to connect to an Analytics data connector. - **[Connectors Stats](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_connectors_stats.htm)** The statistics information for the Analytics connectors. - **[Connector Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_connector_type.htm)** The connector type of an Analytics template variable. - **[Contextual Source Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_contextual_source_asset.htm)** A contextual representation of an Analytics dashboard. - **[Coverage Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_coverage_job.htm)** The output of a user coverage request. - **[Custom Component Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_custom_component_layout.htm)** A custom component layout for an Analytics template wizard page. - **[Custom Component Layout Variable](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_custom_component_layout_variable.htm)** A variable for the custom component layout to pass to the LWC. - **[Daily Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_daily_schedule.htm)** Specify a daily schedule for an Analytics asset. - **[Daily Scheduled Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_daily_scheduled_item.htm)** The daily schedule for a data refresh. - **[Dashboard Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_collection.htm)** A collection of Analytics dashboards. - **[Dashboard Context Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_context_asset.htm)** A contextual representation of an embedded Analytics dashboard. - **[Dashboard Context Location](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_context_location.htm)** A location of an Analytics embedded dashboard. - **[Dashboard Saved View Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_collection.htm)** A collection of Analytics dashboard saved views. - **[Dashboard Saved View Data Source State](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_data_source_state.htm)** A data source state for the saved view of an Analytics dashboard. - **[Dashboard Saved View Filter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_filter.htm)** A filter for the saved view of an Analytics dashboard. - **[Dashboard Saved View Initial](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_inital.htm)** The initial saved view of an Analytics dashboard. - **[Dashboard Saved View State](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_state.htm)** A state for the saved view of an Analytics dashboard. - **[Dashboard Saved View Step Metadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_step_metadata.htm)** The step metadata for the saved view of an Analytics dashboard. - **[Dashboard Saved View Step State](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_step_state.htm)** A step state for the saved view of an Analytics dashboard. - **[Dashboard Saved View](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view.htm)** A saved view for an Analytics dashboard. - **[Dashboard Snapshot Item Data Row](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item_data_row.htm)** An Analytics dashboard snapshot item data row. - **[Dashboard Snapshot Item Last Run](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item_last_run.htm)** The Analytics dashboard snapshot item last run information. - **[Dashboard Snapshot Item Result](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item_result.htm)** An Analytics dashboard snapshot item. - **[Dashboard Snapshot Item Source Dashboard](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item_source_dashboard.htm)** The dashboard source for a dashboard snapshot item. - **[Dashboard Snapshot Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item.htm)** An Analytics dashboard snapshot item. - **[Dashboard Subscription Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_subscription_source.htm)** The dashboard subscription source. - **[Dashboard](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard.htm)** An Analytics dashboard. - **[Data Cloud Extended Metadata Output](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_cloud_extended_metadata_output.htm)** The extended metadata (Xmd) for a Data 360 object data source for Analytics. - **[Data Cloud Field Extended Metadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_cloud_field_extended_metadata.htm)** The extended metadata (Xmd) for a field in Data 360 object. - **[Data Cloud Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_cloud_field_value.htm)** A customized display value for a data object field. - **[Data Connector Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_collection.htm)** A collection of Analytics data connectors. - **[Data Connector Status](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_status.htm)** The status for an Analytics data connector. - **[Data Connector Type Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_type_collection.htm)** A collection of Analytics data connector types. - **[Data Connector Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_type.htm)** An Analytics data connector type. - **[Data Connector](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector.htm)** An Analytics data connector. - **[Dataflow Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_collection.htm)** A collection of Analytics dataflows. - **[Dataflow Job Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_collection.htm)** A collection of Analytics dataflow jobs. - **[Dataflow Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job.htm)** An Analytics dataflow job. - **[Dataflow Job Node Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_collection.htm)** The collection of nodes for an Analytics dataflow job. - **[Dataflow Job Node](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node.htm)** A node in a dataflow job. - **[Dataflow Job Node Stage Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_stage_collection.htm)** The collection of stages for an Analytics dataflow job node. - **[Dataflow Job Node Stage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_stage.htm)** A stage in a dataflow job node. - **[Dataflow Job Node Stage Parents](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_stage_parents.htm)** The parent information for a dataflow job node stage. - **[Dataflow Node Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_node_collection.htm)** The collection of nodes for an Analytics dataflow. - **[Dataflow Node](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_node.htm)** A node in an dataflow job. - **[Dataflow](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow.htm)** An Analytics dataflow. - **[Data Lake Object Field Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_lake_object_field_type.htm)** The data lake object field type of an Analytics template variable. - **[Data Lake Object Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_lake_object_type.htm)** The data lake object type of an Analytics template variable. - **[Data Model Object Field Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_model_object_field_type.htm)** The data model object field type of an Analytics template variable. - **[Data Model Object Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_model_object_type.htm)** The data model object type of an Analytics template variable. - **[Dataset Any Field Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_any_field_type.htm)** The dataset generic field type of an Analytics template variable. - **[Dataset Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_collection.htm)** A collection of datasets. - **[Dataset Coverage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_coverage.htm)** The security coverage for a specific dataset version. - **[Dataset Date Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_date_type.htm)** The date in a dateset type of an Analytics template variable. - **[Dataset Dimension Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_dimension_type.htm)** The dimension in a dateset type of an Analytics template variable. - **[Dataset Measure Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_measure_type.htm)** The measure in a dateset type of an Analytics template variable. - **[Dataset Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_type.htm)** The dateset type of an Analytics template variable. - **[Dataset Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_source.htm)** The source object used to create a dataset. - **[Dataset Version Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version_collection.htm)** A collection of versions for an Analytics dataset. - **[Dataset Version Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version_reference.htm)** The dataset version the coverage information applies to. - **[Dataset Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version.htm)** A specific version of an Analytics dataset. - **[Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset.htm)** An Analytics dataset. - **[Date Time Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_date_time_type.htm)** The date time type of an Analytics template variable. - **[Dependency](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dependency.htm)** An Analytics asset dependency. - **[Dependency Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dependency_collection.htm)** A collection of Analytics asset dependencies. - **[Directory Item Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_directory_item_collection.htm)** A collection of directory items. - **[Display Message](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_display_message.htm)** The display message for an Analytics template. - **[Empty Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_empty_schedule.htm)** Specify an empty schedule for an Analytics asset. - **[Event Driven Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_event_driven_schedule.htm)** Specify an event-driven schedule for an Analytics asset. - **[Featured Assets](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_featured_assets.htm)** The featured assets. - **[Group Box Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_group_box_item.htm)** A group box item on a panel for an Analytics template wizard page. - **[Guidance Panel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_guidance_panel.htm)** The guidance panel for a template configuration wizard page. - **[Header](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_header.htm)** The header for an Analytics template wizard page. - **[Hourly Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_hourly_schedule.htm)** Specify an hourly schedule for an Analytics asset. - **[Geo Data Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_geo_data_collection.htm)** A collection of the geo data used by a map. - **[Geo Data](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_geo_data.htm)** The geo data used by a map. - **[Image Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_image_asset_reference.htm)** A image asset for Analytics. - **[Image Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_image_item.htm)** An image item on a panel for an Analytics template wizard page. - **[Job Event Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_job_event_collection.htm)** A collection of audit events for jobs, like recipe start or dataflow cancelled. - **[Job Event](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_job_event.htm)** An audit events for a job, like recipe start or dataflow cancelled. - **[Json Transformation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_json_transformation.htm)** The transformed JSON after processing the transformation rules. - **[Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_layout.htm)** The base layout for an Analytics template wizard page. - **[Lens Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_collection.htm)** A collection of Analytics lenses. - **[Lens File](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_file.htm)** A file used to generate a lens. - **[Lens Source Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_source_asset.htm)** A contextual representation of an Analytics lens. - **[Lens State](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_state.htm)** The state for an Analytics lenses. - **[Lens](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens.htm)** Am Analytics lenses. - **[License Attributes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_license_attributes.htm)** The Analytics license attributes. - **[Link Asset Destination](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_link_asset_destination.htm)** A link to an Analytics asset. - **[Link Box Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_link_box_item.htm)** A link box item on a panel for an Analytics template wizard page. - **[Literal Json](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_literal_json.htm)** A string of JSON content results, usually for a query response. - **[Live Connection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_live_connection.htm)** The connection details of an Analytics live dataset. - **[Macro Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_macro_definition.htm)** A macro definition that is part of a larger macro for a JSON transformation rule. - **[Map Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_map_collection.htm)** A collection of maps. - **[Map](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_map.htm)** A map object. - **[Mapped SDM](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_mapped_sdm.htm)** A mapped Tableau Next semantic model. - **[Minutely Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_minutely_schedule.htm)** Specify a schedule that runs multiple times an hour for an Analytics asset. - **[Monthly Relative Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_monthly_relative_schedule.htm)** Specify a schedule that runs monthly on a relative day within the month for an Analytics asset. - **[Monthly Specific Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_monthly_specific_schedule.htm)** Specify a schedule that runs monthly on a specific day within the month for an Analytics asset. - **[Navigation Panel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_navigation_panel.htm)** The navigation panel for a template configuration wizard page. - **[Notification Action](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_notification_actions.htm)** A notification action for an Analytics subscription. - **[Node Row Count](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_node_row_count.htm)** The node row count for an Analytics dataflow job node. - **[Number Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_number_type.htm)** The number type of an Analytics template variable. - **[Numeric Separators](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_numeric_separators.htm)** The numeric separators for thousands and decimals, used in formatting. - **[Object Coverage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_object_coverage.htm)** The security coverage for a source object. - **[Object Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_object_type.htm)** The object type of an Analytics template variable. - **[Output Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_output_source.htm)** The output source for an Analytics replicated dataset, also known as a connected object. - **[Page Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_layout.htm)** The page layout definition for an Analytics template. - **[Page Navigation Info](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_navigation_info.htm)** The navigation information for a template configuration wizard page. - **[Page](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page.htm)** A UI page for an Analytics template. - **[Page Variable](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_variable.htm)** An Analytics variable to display on a UI page. - **[Panel Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm)** An item on a panel in a column layout for an Analytics template wizard page. - **[Panel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel.htm)** A panel in a column layout for an Analytics template wizard page. - **[Permissions](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_permissions.htm)** The user permissions for an Analytics asset. - **[Post To Slack Notification Action Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_post_to_slack_notification_action_configuration.htm)** The notification action configuration for posting to Slack. - **[Property Condition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_property_condition.htm)** A condition where the connection property is visible. - **[Property Option](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_property_option.htm)** A value option for Select connection properties. - **[Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_query.htm)** A query written in SAQL or compact form. - **[Replicated Dataset Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_dataset_collection.htm)** A collection of Analytics replicated datasets, also know as connected objects. - **[Replicated Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_dataset.htm)** An Analytics replicated dataset, also know as a connected object. - **[Replicated Field Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_field_collection.htm)** A collection of fields for an Analytics replicated dataset, also known as a connected object. - **[Replicated Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_field.htm)** A field for an Analytics replicated dataset, also known as a connected object. - **[Report Source Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_report_source_asset.htm)** A contextual representation of a report asset. - **[Restore Dataset Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_restore_dataset_version.htm)** The message returned for an Analytics data connector ingest request or an Analytics dataset version update request. - **[Schedule Details](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule_details.htm)** The base Analytics schedule details, inherited by SubscriptionDailySchedule and SubscriptionWeeklySchedule. - **[Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm)** A schedule on which to execute some type of Analytics asset job. - **[Scheduled Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_scheduled_item.htm)** The base schedule for a data refresh. - **[Scheduled Time](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_scheduled_time.htm)** The base schedule for a data refresh. - **[Scheduled Timezone](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_scheduled_timezone.htm)** The information for a schedule time zone. - **[Security Predicate](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_security_predicate.htm)** The security predicate for an Analytics dataset. - **[Send To Email Notification Action Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_send_to_email_notification_action_configuration.htm)** The notification action configuration for sending an email. - **[Sharing Inheritance](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sharing_inheritance.htm)** The sharing inheritance for an Analytics dataset. - **[Single Column Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_single_column_layout.htm)** A single column layout for an Analytics template wizard page. - **[Slack Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_slack_reference.htm)** The reference for a Slack entity. - **[Snapshot](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_snapshot.htm)** An Analytics snapshot. - **[Sobject Field Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm)** The sobject field type of an Analytics template variable. - **[Sobject Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm)** The sobject type of an Analytics template variable. - **[Source Field Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_field_collection.htm)** A collection of fields for a source object. - **[Source Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_field.htm)** A field for a source object. - **[Source Object Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object_collection.htm)** A collection of source objects for an Analytics data connector. - **[Source Object Data](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object_data.htm)** The data retrieved from a source object given a list of fields and advanced properties. - **[Source Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object.htm)** A source object for an Analytics data connector. - **[Size Limit](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_size_limit.htm)** The size limit of an Analytics template array type variable. - **[String Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_string_type.htm)** The string type of an Analytics template variable. - **[Subscription Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_collection.htm)** A collection of Analytics subscriptions. - **[Subscription Daily Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_daily_schedule.htm)** The daily schedule on which to execute an Analytics subscription. - **[Subscription Weekly Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_weekly_schedule.htm)** The weekly schedule on which to execute an Analytics subscription. - **[Subscription Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_schedule.htm)** An Analytics subscription schedule. - **[Subscription Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_source.htm)** The base Analytics subscription source. - **[Subscription](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription.htm)** An Analytics subscription. - **[Template Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_collection.htm)** A collection of Analytics templates. - **[Template Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_configuration.htm)** The configuration for an Analytics Template. - **[Template Custom Attributes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_custom_attributes.htm)** The custom attributes or metadata for an Analytics template. - **[Template Icons](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_icons.htm)** The icons for an Analytics template. - **[Template Lint](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_lint.htm)** The lint score for an Analytics template. - **[Template Lint Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_lint_item.htm)** An individual linting task for an Analytics template. - **[Template Options](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_options.htm)** The template options used on the last action performed on a templated Analytics app. - **[Template Readiness Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_readiness_item.htm)** An individual validation task for an Analytics template. - **[Template Release](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_release.htm)** The release information for an Analytics template. - **[Template Release Notes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_release_notes.htm)** The release notes for an Analytics template. - **[Template Validate](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_validate.htm)** The validation for an Analytics template. - **[Template](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template.htm)** An Analytics template. - **[Text Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_text_item.htm)** A text item on a panel for an Analytics template wizard page. - **[Time](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_time.htm)** The time at which something should happen, usually in relation to an Analytics schedule. - **[Time Zone](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_time_zone.htm)** The time zone in which something should happen, usually in relation to an Analytics schedule. - **[Trended Report Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_trended_report_collection.htm)** A collection of Analytics trended reports. - **[Trended Report](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_trended_report.htm)** An Analytics trended report. - **[Two Column Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_two_column_layout.htm)** A two column layout for an Analytics template wizard page. - **[Typed Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_typed_asset_reference.htm)** A typed Analytics asset reference. - **[UI Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_ui_configuration.htm)** Get the Analytics UI configuration data. - **[UI Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_ui_definition.htm)** The UI definition for an Analytics template. - **[UI Layout Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_ui_layout_definition.htm)** The UI layout definition for an Analytics template. - **[Unsupported Record Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_unsupported_record_collection.htm)** The collection of specific records that unsupported for sharing inheritance. - **[Unsupported Record](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_unsupported_record.htm)** The sharing usage of object instances based on Analytics limits. - **[User Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_user.htm)** Information for a user. Used by the Map representation - **[Validation Page Group](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_validation_page_group.htm)** An org readiness requirement group on a validation page for a template validation wizard page. - **[Validation Page Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_validation_page_layout.htm)** The validation page layout for a template configuration wizard page. - **[Variable Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_definition.htm)** The variable definition for an Analytics template. Specific variable type responses are listed here. - **[Variable Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_item.htm)** A variable item on a panel for an Analytics template wizard page. - **[Variable Item Tile](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_item_tile.htm)** A variable item tile for a variable on a template wizard page. - **[Variable Type](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm)** The abstract type for an Analytics template variable. - **[Video Info](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_video_info.htm)** Information for describing a particular video. - **[Visual Parameters](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_visual_parameters.htm)** A visual parameters for an Analytics watchlist item. - **[Watchlist Snapshot](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist_snapshot.htm)** An Analytics watchlist snapshot collection. - **[Watchlist](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist.htm)** An Analytics watchlist collection. - **[Wave Analytics Limit](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_analytics_limit.htm)** An Analytics limit. - **[Wave Analytics Limit Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_analytics_limit_collection.htm)** The collection of Analytics limits. - **[Wave Asset Bundle](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_asset_bundle.htm)** The Analytics asset bundled with the associated metadata. - **[Wave Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection.htm)** A collection of Analytics resources. - **[Wave Collection Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_item.htm)** An item in a collection of Analytics resources. - **[Wave Collection Item List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_item_list.htm)** A list of items in a collection of Analytics resources. - **[Wave Collection List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_list.htm)** A list of Analytics collections. - **[Wave Features](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_features.htm)** The Analytics features enabled for a user. - **[Wave File Metadata Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_file_metadata_collection.htm)** A collection of the metadata for Analytics files. - **[Wave File Metadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_file_metadata.htm)** The metadata for an Analytics file. - **[Wave Folder](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder.htm)** An Analytics folder. - **[Wave Folder Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder_collection.htm)** A collection of Analytics folders. - **[Wave Folder Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder_schedule.htm)** An Analytics folder schedule. - **[Wave Folder Share](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder_share.htm)** An Analytics folder sharing rule. - **[Wave Unsupported Features](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_unsupported_features.htm)** The unsupported Analytics features for the org. - **[Wave User](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_user.htm)** An Analytics user. - **[Weekly Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_weekly_schedule.htm)** Specify a schedule that runs weekly for an Analytics asset. - **[Weekly Scheduled Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_weekly_scheduled_item.htm)** The weekly schedule for a data refresh. - **[Widget Subscription Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_widget_subscription_source.htm)** The widget subscription source. - **[Xmd Currency Settings](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_currency_settings.htm)** The extended metadata (Xmd) for currency settings of a currency field. - **[Xmd Date Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_date_field.htm)** The extended metadata (Xmd) for the formatting of date fields. - **[Xmd Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_dataset.htm)** The extended metadata (Xmd) for currency settings of a currency field. - **[Xmd Date](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_date.htm)** The extended metadata (Xmd) for a date. - **[Xmd Dimension Custom Action](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_dimension_custom_action.htm)** The extended metadata (Xmd) for a custom action on an Analytics dataset dimension. - **[Xmd Dimension Member](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_dimension_member.htm)** The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset. - **[Xmd Dimension Salesforce Action](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_dimension_salesforce_action.htm)** The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset. - **[Xmd Dimension](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_dimension.htm)** The extended metadata (Xmd) for a dimension in an Analytics dataset. - **[Xmd Measure Format](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_measure_format.htm)** The extended metadata (Xmd) for the format of a measure in an Analytics dataset. - **[Xmd Measure](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_measure.htm)** The extended metadata (Xmd) for a measure in an Analytics dataset. - **[Xmd Metadata Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_metadata_collection.htm)** A collection of Analytics Xmd metadata. - **[Xmd Metadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_metadata.htm)** The metadata for an Analytics Xmd. - **[Xmd Organization](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_organization.htm)** The extended metadata (Xmd) for an organization in an Analytics dataset. - **[Xmd](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd.htm)** The extended metadata (Xmd) for an Analytics dataset version. # CRM Analytics REST Resources REST API resources are sometimes called endpoints. - **[Wave Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_wave.htm)** Lists the top-level resources available for Analytics. - **[Actions Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_actions.htm)** Returns the Salesforce actions available for the user in Analytics. The entityId is the user id. - **[Analytics Assets Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_analytics_assets_overview.htm)** Query Analytics assets using parameters for a collections or query a single asset by ID. - **[Annotation Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_annotations_overview.htm)** Annotate Analytics dashboard widgets with comments posted in the dashboard and in Chatter. - **[Asset Files Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_assetfiles_overview.htm)** Analytics assets contain files to define their previews. Get a collection of files available and individual files, and create and update asset files - **[Auto-Install Request Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_autoinstallrequests_overview.htm)** Auto-Install requests are used to create, update, and delete Analytics embedded apps. Analytics embedded apps are run-time implementations of Analytics templates and instead of user interaction, they’re managed via auto-install requests. - **[Collection Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_overview.htm)** Analytics collections let users manage their own groups of items and personalize their Analytics Studio home page. - **[Dashboard Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_overview.htm)** Analytics dashboards allow users to continuously monitor key metrics of their business. These resources allow users to manage collections of dashboards, individual dashboards, dashboard saved views, dashboard histories, and dashboard publishers. - **[Data Connector Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_overview.htm)** Data connectors are prebuilt connectors to quickly connect to data in your Salesforce orgs, apps, data warehouses, and database services. These resources allow users to manage data connectors and their source objects, run data syncs, and check statuses. - **[Dataflow Job Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_overview.htm)** Dataflow jobs are used to sync data for data prep recipes and standard dataflows. - **[Dataflow Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_overview.htm)** Dataflows are used to prepare data for Analytics, creating one or more datasets using transformations to manipulate the data. - **[Dataset Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_overview.htm)** Manage Analytics dataset and dataset versions. - **[Dependencies Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dependencies_id.htm)** Returns the dependencies for an asset. - **[Eclair Chart Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclaircharts_overview.htm)** Eclair charts render maps and geodata in Analytics dashboards. - **[Features Configuration Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_config_features.htm)** The Analytics features that are available to a user. - **[Folder Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_overview.htm)** Analytics folders represent apps, a collection of assets. Folders can be created by users or by Analytics templates. - **[JsonXform Transformation Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_jsonxform_transformation.htm)** Performs a JSON transformation by invoking a set of rules and expressions on a JSON document. The transformed JSON is returned in the REST response and isn't saved on the server. This service is provided to test rules used in Analytics templates. - **[Limits Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_limits.htm)** The Analytics limits for the Salesforce org. - **[Lens Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_overview.htm)** Analytics lenses are how users view data in a dataset and are the basis for building any dashboard. These resources allow users to manage collections of lenses, individual lenses, and lens files. - **[Query Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_query.htm)** Executes a query written in Salesforce Analytics Query Language (SAQL) or SQL for CRM Analytics. - **[Recipe Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_recipes_overview.htm)** Recipes are used to prepare data, creating a dataset using transformations to manipulate the data. - **[Replicated Dataset Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_overview.htm)** Manage Analytics replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset. - **[Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm)** Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync. - **[Subscription Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_overview.htm)** Manages subscriptions for Analytics dashboards. - **[Security Coverage Dataset Version Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_security_coverage_dataset_version.htm)** Returns the security coverage (sharing inheritance) for a particular dataset version. The source objects listed are local to the org (there are no objects from other orgs or other external sources). - **[Security Coverage Object Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_security_coverage_object.htm)** Returns the security coverage for a particular object. Use this API to discover whether Analytics can inherit sharing settings from an object. - **[Template Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_overview.htm)** Manage Analytics templates, template configuration, and template release notes. - **[Trended Report Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedreports_overview.htm)** Manage Analytics trending reports. - **[Unsupported Features Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_unsupported_features.htm)** Returns the unsupported features for CRM Analytics in the current datacenter environment. - **[Watchlist Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlists_overview.htm)** Manages watchlists for Analytics dashboards. - **[Xmd Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_overview.htm)** Manages Xmds for Analytics datasets and assets. # Custom Component Layout A custom component layout for an Analytics template wizard page. ## Properties Inherits properties from [Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_layout.htm "The base layout for an Analytics template wizard page."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | module | String | A name of the custom LWC module. | Small, 59.0 | 59.0 | | properties | Map | A map of properties to pass to the custom LWC. | Small, 59.0 | 59.0 | | variables | [CustomComponentLayoutVariable](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_custom_component_layout_variable.htm "A variable for the custom component layout to pass to the LWC.")\[\] | A list of the variables for the custom LWC to use. | Small, 59.0 | 59.0 | # Custom Component Layout Variable A variable for the custom component layout to pass to the LWC. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | A name of the variable. | Small, 59.0 | 59.0 | | visibility | String | An optional visibility expression for this variable. | Small, 59.0 | 59.0 | # Daily Schedule Specify a daily schedule for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.") # Daily Schedule Input Specify a daily schedule for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset.") # Daily Scheduled Item The daily schedule for a data refresh. Properties Inherits properties from [Scheduled Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_scheduled_item.htm "The base schedule for a data refresh.") # Daily Scheduled Item Input The daily schedule for a data refresh. Properties Inherits properties from [Scheduled Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_scheduled_item_input.htm "The base schedule for a data refresh.") # Dashboard An Analytics dashboard. ## Properties Dashboard inherits properties from the abstract [Base Templated Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_templated_asset.htm "A base Analytics asset created from a template."). These base properties appear in Dashboard alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`allowPreview`	Boolean	Indicates whether this dashboard is available for preview.	Small, 36.0	36.0
`currentHistoryId`	String	The current saved history to display for the dashboard. If null, the latest dashboard is displayed	Small, 44.0	44.0
`datasets`	AssetReferenceRepresentation[]	The list of datasets used to create this dashboard.	Small, 36.0	36.0
`dateVersion`	Integer	The version of dates used by the dashboard. Valid values are: `1` `2`	Small, 44.0	44.0
`files`	LensFileRepresentation[]	The list of files used to create this dashboard.	Medium, 36.0	36.0
`filesUrl`	String	The URL for the files associated with the dashboard.	Small, 36.0	36.0
`folder`	AssetReferenceRepresentation[]	The folder that contains this dashboard.	Small, 36.0	36.0
`historiesUrl`	String	The URL for the dashboard histories associated with this dashboard.	Small, 44.0	44.0
`layoutAutoSync`	String	Indicates whether the dashboard has auto sync enabled for layouts(`true`) or not (`false`).	Small, 60.0	60.0
`mobileDisabled`	Boolean	Indicates whether the dashboard is disabled for mobile (`true`) or not (`false`).	Small, 41.0	41.0
`refreshDate`	Date	The date of the most recent current dataset that is used by the dashboard, in ISO8601 date format.	Small, 36.0	36.0
`semanticModels`	MappedSDM[]	A list of sementic models for this dashboard.	Small, 67.0	67.0
`state`	DashboardStateRepresentation	The state of the dashboard	Big, 36.0	36.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Small, 51.0	51.0

Parameter Name	Type	Description	Required or Optional	Available Version
`clonedTemplateOrigin`	String	If the asset was cloned from an asset that was created from a template, this is the template origin of the original asset.	Optional	56.0
`currentHistoryId`	String	The current saved history id to display for the dashboard.	Optional	44.0
`dateVersion`	Integer	The version of dates used by the dashboard. Valid values are: 1 2	Optional	44.0
`folder`	AssetReferenceInputRepresentation	The folder in which this dashboard is stored.	Required for POST, optional for PATCH	44.0
`historyLabel`	String	A history label to tag the dashboard version being saved.	Optional	44.0
`layoutAutoSync`	String	Indicates whether the dashboard has auto sync enabled for layouts(`true`) or not (`false`).	Optional	60.0
`mobileDisabled`	Boolean	Indicates whether the dashboard is disabled for mobile (`true`) or not (`false`).	Optional	41.0
`semanticModels`	MappedSDMInput[]	A list of sementic models for this dashboard.	Optional	67.0
`state`	DashboardStateInput	The state of the dashboard.	Required for POST, optional for PATCH	36.0
`type`	ConnectWaveAssetTypeEnum	The asset type. The default type is Dashboard. Valid types are: `Collection` `Component` `ContextualDashboard` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataCloudReport` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `TableauDashboard` `TableauWorkbook` `Template` `Widget` `Workflow`	Optional	44.0
`xmd`	XmdInput	The asset XMD of the dashboard.	Optional	44.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Optional	51.0

#### See Also - [Dashboards List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm "Returns a list of Analytics dashboard or creates a dashboard.") - [Dashboard Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id.htm "Returns, deletes, or updates the dashboard with the specified ID or API name.") # Dashboard Publisher Resource Returns user detail information about the publisher for the given dashboard. Removes a user from the list of publishers for the given dashboard. ## Resource URL /wave/dashboards//publishers/ ## Formats JSON ## Available Version 47.0 ## HTTP Methods GET DELETE ## GET Response Body [Asset Publisher](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_publisher.htm "The publisher of an Analytics asset.") # Dashboard Publishers List Resource Returns a list of users who are assigned as publishers for the given dashboard. Adds the current user to the list of publishers for the given dashboard. Removes all users from the dashboard's publisher list. ## Resource URL /wave/dashboards//publishers ## Formats JSON ## Available Version 47.0 ## HTTP Methods GET POST DELETE ## GET Response Body [Asset Publisher Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_publisher_collection.htm "A collection of asset publishers.") ## POST Request Body The POST request doesn't require request parameters or a request body. The POST request creates the asset publisher record for the user making the request. ![Important](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note_important.png) #### Important A user that has VIEW but not EDIT permissions on a dashboard can add themselves as publisher to view newer versions of the dashboard. This functionality is provided for users who are testers or who approve the newer versions. ## POST Response Body [Asset Publisher](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_publisher.htm "The publisher of an Analytics asset.") # Dashboard Resource Returns, deletes, or updates the dashboard with the specified ID or API name. ## Resource URL /wave/dashboards/ ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getDashboard](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-f2e18ad6-9c26-44f9-a741-8506c14caaf9?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Aura — [ describeDashboard()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods GET DELETE PATCH ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If the specified dashboard is archived (moved to the Recycle Bin), a GET request returns a 404 Not Found error. ## GET Response Body [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard.htm "An Analytics dashboard.") ## PATCH Request Body [Dashboard Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_input.htm "An Analytics dashboard.") ## PATCH Response Body [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard.htm "An Analytics dashboard.") # Dashboard Resources Analytics dashboards allow users to continuously monitor key metrics of their business. These resources allow users to manage collections of dashboards, individual dashboards, dashboard saved views, dashboard histories, and dashboard publishers. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Dashboards List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm "Returns a list of Analytics dashboard or creates a dashboard.") | Returns a collection of Analytics dashboards, or creates a dashboard. | GET, POST | /wave/dashboards | | [Dashboard Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id.htm "Returns, deletes, or updates the dashboard with the specified ID or API name.") | Returns or updates the dashboard with the specified ID or API name. | GET, DELETE, PATCH | /wave/dashboards/ | | [Dashboard Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_bundle.htm "Returns or updates the dashboard bundle with the specified ID or API name.") | Returns or updates the dashboard bundle with the specified ID or API name. | GET, PUT | /wave/dashboards//bundle | | [Dashboard Histories Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_histories.htm "Returns the dashboard histories with the specified ID or API name.") | Returns the dashboard histories with the specified ID or API name. | GET | /wave/dashboards//histories | | [Dashboard Publishers List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_publishers.htm "Returns a list of users who are assigned as publishers for the given dashboard. Adds the current user to the list of publishers for the given dashboard. Removes all users from the dashboard's publisher list.") | Returns a list of users who are assigned as publishers for the given dashboard. Adds the current user to the list of publishers for the given dashboard. Removes all users from the dashboard's publisher list. | GET DELETE POST | /wave/dashboards//publishers | | [Dashboard Publisher Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_publishers_id.htm "Returns user detail information about the publisher for the given dashboard. Removes a user from the list of publishers for the given dashboard.") | Returns user detail information about the publisher for the given dashboard. Removes a user from the list of publishers for the given dashboard. | GET DELETE | /wave/dashboards//publishers/ | | [Dashboard Saved Views List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews.htm "Returns a list of dashboard saved views or creates a single view.") | Returns a list of dashboard saved views or creates a single view. | GET POST | /wave/dashboards//savedviews | | [Dashboard Saved View Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews_id.htm "Returns, deletes, and updates a dashboard saved view.") | Returns, deletes, and updates a dashboard saved view. | GET DELETE PATCH | /wave/dashboards//savedviews/ | | [Dashboard Saved Views Initial Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews_initial.htm "Returns the initial view information for a dashboard saved view. In the UI, the initial view is the default view.") | Returns the initial view information for a dashboard saved view. In the UI, the initial view is the default view. | GET | /wave/dashboards//savedviews/initial | - **[Dashboards List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards.htm)** Returns a list of Analytics dashboard or creates a dashboard. - **[Dashboard Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id.htm)** Returns, deletes, or updates the dashboard with the specified ID or API name. - **[Dashboard Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_bundle.htm)** Returns or updates the dashboard bundle with the specified ID or API name. - **[Dashboard Histories Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_histories.htm)** Returns the dashboard histories with the specified ID or API name. - **[Dashboard Publishers List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_publishers.htm)** Returns a list of users who are assigned as publishers for the given dashboard. Adds the current user to the list of publishers for the given dashboard. Removes all users from the dashboard's publisher list. - **[Dashboard Publisher Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_publishers_id.htm)** Returns user detail information about the publisher for the given dashboard. Removes a user from the list of publishers for the given dashboard. - **[Dashboard Image Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_image_imagefqn.htm)** Returns a dashboard’s image as an asset reference. - **[Dashboard Saved Views List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews.htm)** Returns a list of dashboard saved views or creates a single view. - **[Dashboard Saved View Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews_id.htm)** Returns, deletes, and updates a dashboard saved view. - **[Dashboard Saved Views Initial Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews_initial.htm)** Returns the initial view information for a dashboard saved view. In the UI, the initial view is the default view. # Dashboard Saved View A saved view for an Analytics dashboard. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	String	The saved view id.	Small, 42.0	42.0
`isInitial`	Boolean	Indicates whether the view is the initial view when loading the dashboard or not.	Small, 42.0	42.0
`label`	String	The saved view label.	Small, 42.0	42.0
`pageId`	String	The id of dashboard page this saved view loads on the dashboard.	Small, 42.0	42.0
`state`	DashboardSavedViewState	The selections and filters that were applied directly to the dashboard.	Big, 42.0	42.0
`type`	ConnectWaveDashboardSavedViewType	The type of saved view. `Shared` `User`	Small, 42.0	42.0

Property Name	Type	Description	Filter Group and Version	Available Version
`dataspace`	String	The name of datasapce that the Data 360 object is assigned to.	Small, 62.0	62.0
`fields`	String[]	The dataset fields with filter or selection values.	Small, 42.0	42.0
`filter`	DashboardSavedViewFilter	The filter values.	Small, 42.0	42.0
`type`	ConnectWaveDashbhoardSavedViewDatasetStateType	The type of dataset state. Valid values are: `Global`	Small, 42.0	42.0

# Dashboard Saved View Data Source State Input The data source state for an Analytics dashboard saved view. ## Properties

Property Name	Type	Description	Required or Optional	Available Version
`dataspace`	String	The name of datasapce that the Data 360 object is assigned to.	Optional	62.0
`fields`	String[]	A list of dataset fields.	Required	42.0
`filter`	DashboardSavedViewFilterInput	The filter values.	Required	42.0
`type`	ConnectWaveDashboardSavedViewDatasetStateType	The type of dataset state. Valid values are: `Global`	Required	42.0

# Dashboard Saved View Filter A filter for the saved view of an Analytics dashboard. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | operator | String | The filter operator. | Small, 42.0 | 42.0 | | values | Object\[\] | The list of filter values. | Small, 42.0 | 42.0 | # Dashboard Saved View Filter Input A filter for an Analytics dashboard saved view. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | operator | String | The filter operator. | Required | 42.0 | | values | Object\[\] | The list of filter values. | Required | 42.0 | # Dashboard Saved View Initial The initial saved view of an Analytics dashboard. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | userViewCount | Integer | The number of views saved by the current user on the dashboard. | Small, 42.0 | 42.0 | | view | [DashboardSavedView](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view.htm "A saved view for an Analytics dashboard.") | The user or shared saved view to initially apply to the dashboard. | Small, 42.0 | 42.0 | #### See Also - [Dashboards Saved Views Initial Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews_initial.htm "Returns the initial view information for a dashboard saved view. In the UI, the initial view is the default view.") # Dashboard Saved View Input A saved view for an Analytics dashboard. ## Properties

Property Name	Type	Description	Required or Optional	Available Version
`isInitial`	Boolean	Indicates whether the view is the initial view when loading the dashboard or not.	Optional	42.0
`label`	String	The saved view label.	Required	42.0
`pageId`	String	The dashboard page id this saved view applies to.	Required	42.0
`state`	DashboardSavedViewStateInput	The selections and filters to apply to the dashboard.	Required	42.0
`type`	ConnectWaveDashboardSavedViewType	The type of saved view. `Shared` `User`	Optional	42.0

#### See Also - [Dashboards Saved Views List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews.htm "Returns a list of dashboard saved views or creates a single view.") - [Dashboards Saved View Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews.htm "Returns a list of dashboard saved views or creates a single view.") # Dashboard Saved View Resource Returns, deletes, and updates a dashboard saved view. ## Resource URL /wave/dashboards//savedviews/ ## Formats JSON ## Available Version 42.0 ## Available Components - Aura — [ getDashboardSavedView()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods DELETE GET PATCH ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If a dashboard fails to load because its saved view references dataset fields that were renamed or removed, delete the saved view where isInitial is true to force the dashboard to reload against the current dataset schema. Because User\-type saved views are private to their owner, make this request as that user. ## GET Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dashboardIdOrApiName | String | The ID or API name of the dashboard to retrieve the saved views for. | Required | 42.0 | | viewId | String | The ID of the saved view. | Required | 42.0 | ## GET Response Body [Dashboard Saved View](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view.htm "A saved view for an Analytics dashboard.") ## PATCH Request Body [Dashboard Saved View Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_input.htm "A saved view for an Analytics dashboard.") ## PATCH Response Body [Dashboard Saved View](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view.htm "A saved view for an Analytics dashboard.") # Dashboard Saved View State A state for the saved view of an Analytics dashboard. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | cdpObjects | Map | Map of the fully qualified cdpObject names to cdpObject state. | Small, 55.0 | 55.0 | | components | Map | Map of the fully qualified component names to component state. | Small, 51.0 | 51.0 | | datasets | Map | Map of the fully qualified dataset names to dataset state. | Small, 42.0 | 42.0 | | sObjects | Map | Map of the fully qualified sObject names to sObject state. | Small, 55.0 | 55.0 | | steps | Map | Map of the step ids to step state. | Small, 42.0 | 42.0 | # Dashboard Saved View State Input The state for an Analytics dashboard saved view. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cdpObjects | Map | A map of the fully qualified cdpObject name to cdpObject state. | Required | 55.0 | | components | Map | A map of the fully qualified component names to component state. | Required | 51.0 | | datasets | Map | A map of the fully qualified dataset names to dataset state. | Required | 42.0 | | sObjects | Map | A map of the fully qualified sObject name to sObject state. | Required | 55.0 | | steps | Map | Map of the step ids to step state. | Required | 42.0 | # Dashboard Saved View Step Metadata The step metadata for the saved view of an Analytics dashboard. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | groups | String\[\] | The list of groups step metadata. | Small, 42.0 | 42.0 | # Dashboard Saved View Step Metadata Input The step metadata for an Analytics dashboard saved view. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groups | String\[\] | The list of groups step metadata. | Required | 42.0 | # Dashboard Saved View Step State A step state for the saved view of an Analytics dashboard. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | metadata | [DashboardSavedViewStepMetadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_step_metadata.htm "The step metadata for the saved view of an Analytics dashboard.") | The step metadata. | Small, 42.0 | 42.0 | | values | Object\[\] | The list of step values. | Small, 42.0 | 42.0 | # Dashboard Saved View Step State Input The step state for an Analytics dashboard saved view. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | metadata | [DashboardSavedViewStepMetadataInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_step_metadata_input.htm "The step metadata for an Analytics dashboard saved view.") | The step metadata. | Required | 42.0 | | values | Object\[\] | The list of step values. | Required | 42.0 | # Dashboard Saved Views Initial Resource Returns the initial view information for a dashboard saved view. In the UI, the initial view is the default view. ## Resource URL /wave/dashboards//savedviews/initial ## Formats JSON ## Available Version 42.0 ## Available Components - Aura — [ getDashboardInitialSavedView()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods GET ## GET Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dashboardIdOrApiName | String | The ID or API name of the dashboard to retrieve the initial saved view for. | Required | 42.0 | ## GET Response Body [Dashboard Saved View Initial](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_inital.htm "The initial saved view of an Analytics dashboard.") # Dashboard Saved Views List Resource Returns a list of dashboard saved views or creates a single view. ## Resource URL /wave/dashboards//savedviews ## Formats JSON ## Available Version 42.0 ## Available Components - Aura — [ listDashboardSavedViews()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods GET POST ## GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`dashboardIdOrApiName`	String	The ID or API name of the dashboard to retrieve the saved views for.	Required	42.0
`type`	ConnectWaveDashboardSavedViewType	The type of saved view. `Shared` `User`	Optional	42.0

The following REST URL shows how to use the type parameter in the GET request. /wave/dashboards//savedviews?type=User ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If a dashboard fails to load for a user, their saved view might reference dataset fields that were renamed or removed after the view was created. See the note under the [Dashboard Saved View Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_savedviews_id.htm "Returns, deletes, and updates a dashboard saved view.") for how to remove a stale default view. ## GET Response Body [Dashboard Saved View Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view_collection.htm "A collection of Analytics dashboard saved views.") ## POST Request Body [Dashboard Saved View Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_saved_view_input.htm "A saved view for an Analytics dashboard.") ## POST Response Body [Dashboard Saved View](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_saved_view.htm "A saved view for an Analytics dashboard.") # Dashboard Snapshot Item An Analytics dashboard snapshot item. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`destinationLink`	`LinkAssetDestination`	The destination link for the item.	Small, 48.0	48.0
`driftState`	`ConnectDashboardSnapshotDriftState`	The drift state of the snapshot item. Valid values are: `Clean` (Indicates the snapshot is clean) `Dirty` (Indicates the snapshot has drifted and is dirty) `IgnoreQueryDrift` (Indicates the snapshot is dirty, but user has ignored it)	Small, 48.0	48.0
`id`	String	The id of the item.	Small, 48.0	48.0
`lastRunInfo`	`DashboardSnapshotItemLastRun`	The last run of the item.	Small, 48.0	48.0
`parameters`	`VisualParameters`	The visual parameters of the item.	Small, 48.0	48.0
`snapshotDashboardId`	String	The id of the snapshot dashboard.	Small, 48.0	48.0
`sourceDashboard`	`DashboardSnapshotItemSourceDashboard`	The source dashboard of the item.	Small, 48.0	48.0
`stepId`	String	The id of the step in the snapshot dashboard.	Small, 48.0	48.0

# Dashboard Snapshot Item Data Row An Analytics dashboard snapshot item data row. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | snapshotDate | Date | The timestamp when the dashboard snapshot item value was calculated. | Small, 48.0 | 48.0 | | snapshotDateLabel | String | The timestamp when the dashboard snapshot item value was calculated in yyyy-mm-dd format. | Small, 48.0 | 48.0 | | snapshotDate | Double | The calculated value of the dashboard snapshot item. | Small, 48.0 | 48.0 | # Dashboard Snapshot Item Last Run The Analytics dashboard snapshot item last run information. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`lastRunDate`	Date	The timestamp when the dashboard snapshot item was run.	Small, 48.0	48.0
`lastRunStatus`	ConnectDashboardSnapshotItemLastRunStatusEnum	The status of the dashboard snapshot item run. Valid values are: `DashboardBundleFailedToLoad` `FailedToParseValue` `FailedToPersistData` `GenericException` `QueryExecutionFailed` `Success`	Small, 48.0	48.0

# Dashboard Snapshot Item Result An Analytics dashboard snapshot item. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataRows | [DashboardSnapshotItemDataRow](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item_data_row.htm "An Analytics dashboard snapshot item data row.")\[\] | The collection of dashboard snapshot item data. | Small, 48.0 | 48.0 | | lastRunInfo | [DashboardSnapshotItemLastRun](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item_last_run.htm "The Analytics dashboard snapshot item last run information.") | The last run of the dashboard snapshot item. | Small, 48.0 | 48.0 | #### See Also - [Watchlist Item Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_id.htm "Return, update, and delete a watchlist item.") # Dashboard Snapshot Item Source Dashboard The dashboard source for a dashboard snapshot item. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | version | String | The version of the source dashboard. | Small, 48.0 | 48.0 | # Dashboard State Input Representation This page contains the reference for the DashboardStateInputRepresentation resource and all the representations that make up the dashboard state for API POST and PATCH requests. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API request bodies. ## DashboardStateInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`dataSourceLinks`	DashboardDataSourceLinkInputRepresentation[]	The list of datasource links used as part of the dashboard.	Optional	DEPRECATED 39.0-56.0
`dataSourceLinksInfo`	DashboardDataSourceLinksInfoInputRepresentation[]	The list of datasource links information used as part of the dashboard.	Optional	57.0
`filters`	FilterItemInputRepresentation[]	The list of datasource filters applied in the dashboard.	Optional	41.0
`gridLayouts`	GridLayoutInputRepresentation[]	The list of GridLayoutInputRepresentation objects used as part of this dashboard. If present, `layouts` must not be set.	Optional	36.0
`layouts`	LayoutInputRepresentation[]	The list of LayoutInputRepresentation objects used as part of this dashboard.	Optional	36.0
`parameters`	ParameterItemInputRepresentation[]	The list of parameters created for this dashboard.	Optional	58.0
`steps`	Map<String, StepInputRepresentation>	The map of all the steps used to create this dashboard keyed with the step names. Valid step types are: AggregateFlexQueryStepInputRepresentation AggregateStepInputRepresentation ApexStepInputRepresentation CdpStepInputRepresentation DirectReportStepInputRepresentation ForecastingStepInputRepresentation HierarchyStepInputRepresentation InputStepInputRepresentation GrainStepInputRepresentation LensStepInputRepresentation MultistepInputRepresentation SqlStepInputRepresentation SaqlStepInputRepresentation SoqlStepInputRepresentation StaticFlexStepInputRepresentation	Optional	36.0
`widgetStyle`	GridLayoutWidgetStyleInputRepresentation	The default styling for widgets in this dashboard.	Optional	37.0
`widgets`	Map<String, DashboardWidgetInputRepresentation>	The map of all the DashboardWidgetInputRepresentation objects used to create this dashboard keyed with their names.	Optional	36.0

## DashboardDataSourceLinkInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [DashboardDataSourceFieldInputRepresentation](#DashboardDataSourceFieldInputRepresentation)\[\] | The list of fields connected in the datasource link. | Required | 39.0 | | label | String | The label of the datasource link. | Required | 39.0 | | name | String | The name of the datasource link. | Required | 39.0 | ## DashboardDataSourceLinksInfoInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | enableAutomaticLinking | Boolean | Indicates whether automatic linking is enabled for the dashboard (true) or not (false). | Optional | 57.0 | | excludeRelationships | [DashboardDataSourceRelationshipInputRepresentation](#DashboardDataSourceRelationshipInputRepresentation)\[\] | The list of data source exclude relationships from faceting in the dashboard. | Optional | 57.0 | | links | [DashboardDataSourceLinkInputRepresentation](#DashboardDataSourceLinkInputRepresentation)\[\] | The list of data source links for the dashboard. | Required | 57.0 | ## DashboardDataSourceRelationshipInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`fromDataSource`	String	The fully qualified name of the "from" data source.	Required	57.0
`fromDataSourceType`	ConnectWaveDataSourceTypeEnum	The type of the "from" data source. Valid values are: `Apex` `Cdp` `Dataset` `Hierarchy` `ReportType` `Saql` `Sobject` `Static`	Required	57.0
`toDataSource`	String	The fully qualified name of the "to" data source.	Required	57.0
`toDataSourceType`	ConnectWaveDataSourceTypeEnum	The type of the "to" data source. Valid values are: `Apex` `Cdp` `Dataset` `Hierarchy` `ReportType` `Saql` `Sobject` `Static`	Required	57.0

## DashboardDataSourceFieldInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`dataSourceName`	String	The developer name of the data source.	Required	39.0
`dataSourceNamespace`	String	The namespace that qualifies the dataset asset name.	Optional	39.0
`dataSourceType`	ConnectWaveDataSourceTypeEnum	The type of datasource. Valid values are: `Apex` `Cdp` `Dataset` `Hierarchy` `ReportType` `Saql` `Sobject` `Static`	Required	39.0
`dataspace`	String	The name of datasapce that the Data 360 object is assigned to.	Optional	62.0
`fieldName`	String	The name of the field in data source.	Required	39.0

## ParameterItemInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | defaultValue | Object | The default value of the parameter. | Required | 58.0 | | description | String | The description of the parameter. | Optional | 58.0 | | label | String | The label of the parameter. | Optional | 58.0 | | name | String | The name of the parameter. | Required | 58.0 | ## FilterItemInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cdpObject | String | The Data 360 datasource the filter applies to. | Required | 55.0 | | dataset | [AssetReferenceInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceInputRepresentation) | The datasource the filter applies to. | Required | 41.0 | | dependent | Boolean | Indicates whether the filter item is dependent (true) or not (false). | Optional | 45.0 | | fields | String\[\] | The list of fields in filter. | Optional | 41.0 | | hidden | Boolean | Indicates whether the filter is hidden in view mode (true) or not (false). | Optional | 41.0 | | label | String | The label of the filter. | Optional | 41.0 | | locked | Boolean | Indicates whether the filter is locked (true) or not (false). | Optional | 41.0 | | operator | String | The operator for the filter. | Required | 41.0 | | sObject | String | The sObject datasource the filter applies to. | Required | 55.0 | | value | String | The value for the filter. | Required | 41.0 | ## GridLayoutStyleInputRepresentation GridLayoutStyleInputRepresentation inherits properties from the abstract [ImageParametersInputRepresentation](#ImageParametersInputRepresentation). These base properties appear in GridLayoutStyleInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | Background color for the layout. | | 37.0 | | cellSpacingX | Integer | Horizontal spacing between grid cells. | | 37.0 | | cellSpacingY | Integer | Vertical spacing between grid cells. | | 37.0 | | gutterColor | String | Gutter color of the layout. | | 39.0 | | widgetStyle | [GridLayoutWidgetStyleInputRepresentation](#GridLayoutWidgetStyleInputRepresentation) | Default styling for widgets across all layouts. | Optional | 36.0 | ## AggregateFlexQueryStepInputRepresentation AggregateFlexQueryStepInputRepresentation inherits properties from the abstract [LegacyStepWithQueryInputRepresentation](#LegacyStepWithQueryInputRepresentation). These base properties appear in AggregateFlexQueryStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether the steps broadcasts facets (true) or not (false). | Optional | 41.0 | | cdpObject | String | The name of the Data 360 object used for the query. | Optional | 54.0-57.0 | | cdpObjects | String | A list of the Data 360 object names used for the query. | Optional | 58.0 | | connectionName | String | The name of the connection used for querying external data. | Optional | 48.0 | | dataspace | String | The dataspace name for Data 360 objects. | Optional | 61.0 | | receiveFacetSource | [ReceiveFacetSourceInputRepresentation](#ReceiveFacetSourceInputRepresentation) | The receive facet source configuration for the step. | Optional | 36.0 | | sobject | String | The name of the sObject used for the SOQL query. | Required | 47.0 | | values | Map | A map of dynamic data values. | Optional | 57.0 | ## AggregateStepInputRepresentation AggregateStepInputRepresentation inherits properties from the abstract [LegacyStepWithQueryInputRepresentation](#LegacyStepWithQueryInputRepresentation). These base properties appear in AggregateStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Required | 36.0 | ## ApexStepInputRepresentation ApexStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#StepInputRepresentation). These base properties appear in ApexStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | query | [ApexStepQueryInputRepresentation](#ApexStepQueryInputRepresentation) | The query for the step | Required | 41.0 | ## ApexStepQueryInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | body | Object | The body for the Apex request. | Required | 41.0 | | path | String | The path to the Apex controller. | Required | 41.0 | ## CdpStepInputRepresentation CdpStepInputRepresentation inherits properties from the abstract [FlexMetadataWithSimpleQueryStepInputRepresentation](#FlexMetadataWithSimpleQueryStepInputRepresentation). These base properties appear in CdpStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 54.0 | | dataspace | String | The dataspace name for Data 360 objects. | Optional | 61.0 | | receiveFacetSource | [ReceiveFacetSourceInputRepresentation](#ReceiveFacetSourceInputRepresentation) | The receive facet source configuration | Required | 54.0 | | useLegacyCdpQueryApi | Boolean | Indicates whether this step uses the legacy Data 360 Query API (true) or not (false). | Optional | 65.0 | | values | Map | A map of dynamic data values. | Required | 59.0 | ## DirectReportStepInputRepresentation DirectReportStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#StepInputRepresentation). These base properties appear in DirectReportStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Optional | 56.0 | | query | [DirectReportStepQueryInputRepresentation](#DirectReportStepQueryInputRepresentation) | The query to run for this step. | Required | 53.0 | | receiveFacetSource | [ReceiveFacetSourceInputRepresentation](#ReceiveFacetSourceInputRepresentation) | The receive facet configuration. | Optional | 56.0 | ## ForecastingStepInputRepresentation ForecastingStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#StepInputRepresentation). These base properties appear in ForecastingStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | query | [ForecastingStepQueryInputRepresentation](#ForecastingStepQueryInputRepresentation) | The query to run for this step. | Required | 59.0 | ## GrainStepInputRepresentation GrainStepInputRepresentation inherits properties from the abstract [LegacyStepWithQueryInputRepresentation](#LegacyStepWithQueryInputRepresentation). These base properties appear in GrainStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Required | 36.0 | ## HierarchyStepInputRepresentation HierarchyStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#StepInputRepresentation). These base properties appear in HierarchyStepInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`filterField`	String	The filter field to pass to the role hierarchy evaluation.	Required	55.0
`hierarchyType`	HierarchyTypeEnum	The type of hierarchy used to facet. Valid values are: `ForecastHierarchy` `RoleHierarchy`	Required	55.0
`query`	HierarchyStepQueryRepresentation	The query parameters to pass to the role hierarchy evaluation.	Required	55.0

## HierarchyStepQueryInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | limit | Integer | The maximum amount of results to return for this step. | Required | 55.0 | ## InputStepInputRepresentation InputStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#bi_resources_dashboard_state_input_rep "This page contains the reference for the DashboardStateInputRepresentation resource and all the representations that make up the dashboard state for API POST and PATCH requests. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API request bodies."). These base properties appear in InputStepInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`start`	String	The start value for the step.	Required	56.0
`valueType`	ConnectWaveInputWidgetValueFormatEnum	The value type of the step. Valid values are: `Date` `Number` `Text`	Required	56.0
`values`	InputStepValuesInputRepresentation[]	The list of values for the step.	Required	56.0

## InputStepValuesInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | max | String | The max column in values. | Required | 56.0 | | min | String | The min column in values. | Required | 56.0 | ## LensStepInputRepresentation LensStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#StepInputRepresentation). These base properties appear in LensStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | source | [AssetReferenceInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceInputRepresentation) | The lens source for this step. | Required | 50.0 | ## MultiStepInputRepresentation MultiStepInputRepresentation inherits properties from the abstract [LegacyStepInputRepresentation](#LegacyStepInputRepresentation). These base properties appear in MultiStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | columns | [ColumnInputRepresentation](#ColumnInputRepresentation)\[\] | The list of columns of the comparison table. | Optional | 36.0 | | globalQuery | [QueryInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_lens_state_input.htm#QueryInput) | The SAQL used to create the step. | Optional | 36.0 | | isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Optional | 36.0 | ## SqlStepInputRepresentation SqlStepInputRepresentation inherits properties from the abstract [FlexMetadataWithSimpleQueryStepInputRepresentation](#FlexMetadataWithSimpleQueryStepInputRepresentation). These base properties appear in SqlStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 51.0 | | connectionName | String | The name of the connection used for querying external data | Required | 51.0 | | receiveFacetSource | [ReceiveFacetSourceInputRepresentation](#ReceiveFacetSourceInputRepresentation) | The receive facet configuration. | Optional | 52.0 | ## SaqlStepInputRepresentation SaqlStepInputRepresentation inherits properties from the abstract [FlexMetadataWithSimpleQueryStepInputRepresentation](#FlexMetadataWithSimpleQueryStepInputRepresentation). These base properties appear in SaqlStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 41.0 | | receiveFacetSource | [ReceiveFacetSourceInputRepresentation](#ReceiveFacetSourceInputRepresentation) | The receive facet source configuration | Required | 48.0 | | values | Map | A map of dynamic data values. | Required | 57.0 | ## SoqlStepInputRepresentation SoqlStepInputRepresentation inherits properties from the abstract [FlexMetadataWithSimpleQueryStepInputRepresentation](#FlexMetadataWithSimpleQueryStepInputRepresentation). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 55.0 | | receiveFacetSource | [ReceiveFacetSourceInputRepresentation](#ReceiveFacetSourceInputRepresentation) | The receive facet source configuration. | Optional | 55.0 | ## StaticFlexStepInputRepresentation StaticFlexStepInputRepresentation inherits properties from the abstract [FlexMetadataStepInputRepresentation](#FlexMetadataStepInputRepresentation). These base properties appear in StaticFlexStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Optional | 41.0 | | columns | Map | A map of metadata values for the columns. | Optional | 41.0 | | datasets | [AssetReferenceInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceInputRepresentation)\[\] | **DEPRECATED** The list of all the datasets used for the step. | Optional | 36.0-40.0 | | dimensions | String\[\] | **DEPRECATED** The list of the dimensions for the step. | Optional | 36.0-40.0 | | isFacet | Boolean | **DEPRECATED** Indicates whether the step is faceted (true) or not (false). | Optional | 36.0-40.0 | | isGlobal | Boolean | Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). | Optional | 38.0 | | values | String\[\] | The list of values of this step. | Optional | 36.0 | ## StaticStepInputRepresentation StaticStepInputRepresentation inherits properties from the abstract [LegacyStepInputRepresentation](#LegacyStepInputRepresentation). These base properties appear in StaticStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dimensions | String\[\] | The list of dimensions of the static step. | Optional | 36.0 | | isFacet | Boolean | Indicates whether the step is faceted (true) or not (false). | Optional | 36.0 | | values | String\[\] | The list of values for the step. | Optional | 36.0 | | visualizationParameters | [StepVisualizationParametersInputRepresentation](#StepVisualizationParametersInputRepresentation) | The visualization parameters for the dashboard step. | Optional | 36.0 | ## FlexMetadataWithSimpleQueryStepInputRepresentation FlexMetadataWithSimpleQueryStepInputRepresentation inherits properties from the abstract [FlexMetadataStepInputRepresentation](#FlexMetadataStepInputRepresentation). These base properties appear in FlexMetadataWithSimpleQueryStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | query | String | The query for the step. | Optional | 39.0 | ## FlexMetadataStepInputRepresentation FlexMetadataStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#StepInputRepresentation). These base properties appear in FlexMetadataStepInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groups | Object | The subset of columns that define a semantic for the step. | Optional | 39.0 | | numbers | Object | The number-based columns for the step. | Optional | 39.0 | | strings | Object | The string-based columns for the step. | Optional | 39.0 | ## LegacyStepWithQueryInputRepresentation LegacyStepWithQueryInputRepresentation inherits properties from the abstract [LegacyStepInputRepresentation](#LegacyStepInputRepresentation). These base properties appear in LegacyStepWithQueryInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`query`	String	QueryInput[] The query for the step.	Required	39.0

## LegacyStepInputRepresentation LegacyStepInputRepresentation inherits properties from the abstract [StepInputRepresentation](#StepInputRepresentation). These base properties appear in LegacyStepInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`datasets`	String	AssetReferenceInputRepresentation[] The list of datasets used by the step.	Required	39.0
`isGlobal`	Boolean	Indicates whether the step is a global filter which can be faceted to other steps or widgets in the dashboard (`true`) or not (`false`).	Optional	36.0

## StepInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`label`	String	The display label of the step.	Optional	39.0
`selectMode`	ConnectWaveSelectModeEnum	The select mode types. Valid values are: Multi MultiRequired None Single SingleRequired	Optional	36.0
`sortable`	Boolean	Indicates whether this step supports quick sorting in preview mode (`true`) or not (`false`).	Optional	64.0
`start`	String	The start value of the step.	Optional	36.0
`useExternalFilters`	Boolean	Indicates whether this step uses external filters (`true`) or not (`false`).	Optional	64.0
`useGlobal`	Boolean	Indicates whether the step is tied to the global step (`true`) or not (`false`).	Optional	36.0
`visualizationParameters`	StepVisualizationParametersInputRepresentation	The visualization parameters for the step.	Optional	36.0

## DirectReportStepQueryInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`metadata`	Object	The metadata for the query.	Required	53.0
`mode`	DirectReportModeEnum	The query mode. Valid values are: `Aggregate` `Details` `Summary`	Required	53.0
`reportId`	String	The ID for the query report.	Required	53.0

## ForecastingStepQueryInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | forecastTypeId | String | The forecast type for the query. | Required | 59.0 | | startDate | Object | The start date for the query. | Required | 59.0 | | territoryId | String | The territory ID for the query. | Required | 59.0 | | userId | String | The user ID for the query. | Required | 59.0 | ## StaticFlexStepColumnInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`aggregateFunction`	String	The aggregate function for the step.	Optional	47.0
`dataset`	AssetReferenceInputRepresentation	The dataset for the step.	Required	47.0
`field`	String	The aggregate field for the step.	Required	47.0
`type`	ConnectWaveDashboardStaticStepColumnTypeEnum	The column type. Valid values are String Number Grouping Aggregate	Required	47.0

## ColumnInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`format`	ConnectWaveColumnFormatEnum	The column format value. Valid values are: `CurrencyCents` `CurrencyDollars` `Number` `Percentage`	Optional	36.0
`header`	String	The header text of this column.	Optional	36.0
`hidden`	Boolean	Indicates whether the column is hidden (`true`) or not (`false`).	Optional	36.0
`query`	QueryInput	The SAQL used to create the comparison table.	Optional	36.0
`showBars`	Boolean	Indicates whether to show bars for the column (`true`) or not (`false`).	Optional	36.0
`sort`	ConnectWaveColumnSortEnum	The column sort order. Valid values are: `None` `Ascending` `Descending` `InnerAscending` `InnerDescending`	Optional	36.0

## ReceiveFacetSourceInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`mode`	ConnectWaveDashboardStepReceiveFacetModeTypeEnum	The type of receive facet mode. Valid values are: All Exclude Include None	Required	48.0
`steps`	String[]	A list of steps that the current step receives or omits faceting from.	Required	48.0

## StepVisualizationParametersInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`options`	LensVisualizationOptionsInput	The visualization option associated with this step.	Optional	36.0
`parameters`	Object	The valid widget parameters based on its type.	Optional	40.0
`type`	ConnectWaveWidgetTypeEnum	The type of the widget. Valid values are: `Box` `Chart` `CompareTable` `Component` `Container` `DateSelector` `FilterPanel` `GlobalFilters` `Image` `Inherit` `Link` `ListSelector` `Navigation` `Number` `PillBox` `RangeSelector` `Repeater`> `Table` `Text` `Url` `ValuesTable`		40.0
`visualizationType`	ConnectWaveVisualizationTypeEnum	The type of visualization. Valid values are: `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gantt` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	Optional	36.0

## GridLayoutInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`maxWidth`	Integer	The maximum width that the dashboard flexes to.	Optional	38.0
`name`	String	Name of this layout.	Required	36.0
`numColumns`	Integer	The number of columns for a customizable dashboard grid layout.	Optional	38.0
`pages`	GridLayoutPageInputRepresentation[]	The list of pages of widgets within the layout.	Optional	36.0
`rowHeight`	ConnectWaveRowHeightEnum	Specifies the grid cell row height. Valid values are: Fine Normal	Optional	39.0
`selectors`	String[]	The list of selectors the layout applies to.	Optional	36.0
`style`	GridLayoutStyleInputRepresentation	The styling for the layout.	Optional	37.0
`version`	Double	Version of this layout.	Required	36.0
`widgetStyle`	GridLayoutWidgetStyleInputRepresentation	DEPRECATED Default styling for widgets within the layout.	Optional	36.0-37.0

## GridLayoutPageInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | label | String | The display label for the page. | Optional | 41.0 | | name | String | The unique id for a page within a layout. | Required | 41.0 | | navigationHidden | Boolean | Indicates whether the page is hidden in the navigation widget (true) or not (false). | Optional | 44.0 | | widgets | [GridLayoutWidgetInputRepresentation](#GridLayoutWidgetInputRepresentation)\[\] | The list of widgets within the page. | Required | 36.0 | ## GridLayoutWidgetInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | backgroundImage | String | The background image for the widget. | Optional | 36.0 | | colspan | Integer | The number of grid layout columns this widget spans. | Required | 36.0 | | column | Integer | The column where this widget is located. | Required | 36.0 | | name | String | The name of the widget. | Required | 36.0 | | row | Integer | The row where this widget is located. | Required | 36.0 | | rowspan | Integer | The number of grid layout rows this widget spans. | Required | 36.0 | | widgetStyle | [GridLayoutWidgetStyleInputRepresentation](#GridLayoutWidgetStyleInputRepresentation) | The style of the widget. | Required | 36.0 | ## GridLayoutWidgetStyleInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`backgroundColor`	String	The background color for the widget. This is a 6 character hex string. For example: #012345.	Required	36.0
`borderColor`	String	The color of the widget border. This is a 6 character hex string. For example: #012345.	Required	36.0
`borderEdges`	ConnectWaveBorderEdgeTypeEnum[]	The edges of the border to be drawn. Valid values are: All Bottom Left Right Top	Required	36.0
`borderRadius`	Integer	The border radius of the widget.	Optional	36.0
`borderWidth`	Integer	The width of the widget's border.	Required	36.0
`bottomPadding`	Integer	The amount of padding on the bottom of the widget when rendered on mobile clients.	Optional	36.0
`leftPadding`	Integer	The amount of padding on the left of the widget when rendered on mobile clients.	Optional	36.0
`rightPadding`	Integer	The amount of padding on the right of the widget when rendered on mobile clients.	Optional	36.0
`tooltipStyle`	TooltipStyleInputRepresentation	The style for the dashboard tooltips.	Optional	63.0
`topPadding`	Integer	The amount of padding on the top of the widget when rendered on mobile clients.	Optional	36.0

## LayoutInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`device`	ConnectWaveLayoutDeviceTypeEnum	The device rendering this dashboard. Valid values are: `Applewatch` `Default` `External` `Ipad` `Iphone`	Optional	36.0
`orientation`	ConnectWaveLayoutOrientationTypeEnum	The layout orientation of this dashboard. Valid values are: `Landscape` `Portrait`	Optional	36.0
`pages`	LayoutPageInputRepresentation[]	The list of LayoutPageInputRepresentation objects available for the dashboard.	Optional	36.0
`version`	Double	The version of the layout representation for the dashboard.	Optional	36.0

## LayoutPageInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | rows | String\[\] | The rows associated with the layout page. | Optional | 36.0 | ## DashboardWidgetInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`parameters`	Object	The valid widget parameters based on the type of widget. Parameter types include: `BoxWidgetParametersInputRepresentation` `CompareTableWidgetParametersInputRepresentation` `ComponentWidgetParametersInputRepresentation` `ContainerWidgetParametersInputRepresentation` `DateSelectorWidgetParametersInputRepresentation` `FilterPanelWidgetParametersInputRepresentation` `GlobalFiltersWidgetParametersInputRepresentation` `ImageWidgetParametersInputRepresentation` `InheritWidgetParametersInputRepresentation` `InputWidgetParametersInputRepresentation` `LinkWidgetParametersInputRepresentation` `ListSelectorWidgetParametersInputRepresentation` `NavigationWidgetParametersInputRepresentation` `NumberWidgetParametersInputRepresentation` `PillBoxWidgetParametersInputRepresentation` `RangeSelectorWidgetParametersInputRepresentation` `RepeaterWidgetParametersInputRepresentation` `TableWidgetParametersInputRepresentation` `TextWidgetParametersInputRepresentation` `UrlWidgetParametersInputRepresentation` `ValuesTableWidgetParametersInputRepresentation`	Optional for PATCH, required for POST	36.0
`position`	WidgetPositionInputRepresentation	The position information of the widget on a dashboard.	Optional for PATCH, required for POST	36.0
`type`	ConnectWaveWidgetTypeEnum	The type of the widget. Valid values are: `Box` `Chart` `CompareTable` `Component` `Container` `DateSelector` `FilterPanel` `GlobalFilters` `Image` `Inherit` `Link` `ListSelector` `Navigation` `Number` `PillBox` `RangeSelector` `Repeater`> `Table` `Text` `Url` `ValuesTable`	Optional for PATCH, required for POST	36.0

## BoxWidgetParametersInputRepresentation BoxWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in BoxWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | The background color to be used for the widget. | Optional | 36.0 | | borderColor | String | The border color to be used for the widget. | Optional | 36.0 | | imageUrl | String | The documentId of the image to be used for the widget. | Optional | 36.0 | | stretch | Boolean | Indicates whether to stretch the widget (true) or not (false). | Optional | 36.0 | ## CompareTableWidgetParametersInputRepresentation CompareTableWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in CompareTableWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | exploreLink | Boolean | Indicates whether to display the explore link (true) or not (false). | Optional | 36.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Optional | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Optional | 36.0 | | step | String | The step name for the widget. | Optional | 36.0 | | totals | Boolean | Indicates whether the totals column is displayed (true) or not (false). | Optional | 36.0 | ## ComponentWidgetParametersInputRepresentation ComponentWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in ComponentWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | Object | The map of this component's attribute values. | Required | 51.0 | | dynamicAttributes | Object | The map of this component's dynamic attribute values. | Optional | 59.0 | | pageName | String | The default page of this widget. | Required | 50.0 | | shareState | Boolean | Indicates whether this component widget shares state with the parent dashboard (true) or not (false). | Required | 51.0 | | source | [TypedAssetReferenceInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#TypedAssetReferenceInputRepresentation) | The source asset for the component widget. | Required | 46.0 | | step | String | The attached step for this component widget. | Required | 51.0 | ## ContainerWidgetParametersInputRepresentation ContainerWidgetParametersInputRepresentation inherits properties from the [ImageWidgetParametersInputRepresentation](#ImageWidgetParametersInputRepresentation). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | interactions | [InteractionInputRepresentation](#InteractionInputRepresentation)\[\] | A list of the interaction parameters for the widget. | Optional | 58.0 | ## DateSelectorWidgetParametersInputRepresentation DateSelectorWidgetParametersInputRepresentation inherits properties from the abstract [SelectorWidgetParametersInputRepresentation](#SelectorWidgetParametersInputRepresentation). These base properties appear in DateSelectorWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`absoluteModeEnabled`	Boolean	Indicates whether absolute mode is enabled (`true`) or not (`false`).	Optional	43.0
`calendarTypeSwitchingAllowed`	Boolean	Indicates whether the widget can switch calendar types (`true`) or not (`false`).	Optional	39.0
`customFilterPresets[]`	CustomFilterPresetTypeEnum	The list of custom preset filters. Valid values are: `AllTime` `CurrentFiscalQuarter` `CurrentFiscalQuarterToDate` `CurrentFiscalYear` `CurrentFiscalYearToDate` `CurrentMonth` `CurrentMonthToDate` `CurrentQuarter` `CurrentQuarterToDate` `CurrentWeek` `CurrentYear` `CurrentYearToDate` `Last180Days` `Last30Days` `Last7Days` `Last90Days` `Next180Days` `Next30Days` `Next7Days` `Next90Days` `NextFiscalQuarter` `NextFiscalYear` `NextMonth` `NextQuarter` `NextWeek` `NextYear` `PreviousFiscalQuarter` `PreviousFiscalQuarterToDate` `PreviousFiscalYear` `PreviousFiscalYearToDate` `PreviousFiscalMonth` `PreviousFiscalMonthToDate` `PreviousQuarter` `PreviousQuarterToDate` `PreviousWeek` `PreviousYear` `PreviousYearToDate`	Optional	54.0
`defaultAbsoluteMode`	Boolean	DEPRECATED Indicates whether default date mode is absolute (`true`) or not (`false`).	Optional	39.0-42.0
`defaultFiscalMode`	Boolean	Indicates whether the fiscal mode is default (`true`) or not (`false`).	Optional	39.0
`displayMode`	ConnectWaveSelectorDisplayModeEnum	The display mode type. Valid values are: `Combo` `Filter`	Optional	54.0
`expanded`	Boolean	Indicates whether the date selector is expanded (`true`) or not (`false`)	Optional	36.0
`presetsEnabled`	Boolean	Indicates whether presets are expanded (`true`) or not (`false`).	Optional	43.0
`modeSwitchingAllowed`	Boolean	DEPRECATED Indicates whether the widget can switch between two date modes (`true`) or not (`false`).		39.0-42.0
`relativeModeEnabled`	Boolean	Indicates whether relative mode is enabled (`true`) or not (`false`).		43.0

## FilterPanelWidgetParametersInputRepresentation FilterPanelWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in FilterPanelWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | filterItemOptions | [FilterItemOptionsInputRepresentation](#FilterItemOptionsInputRepresentation) | The filter item options. | Optional | 41.0 | | filters | [FilterItemReferenceInputRepresentation](#FilterItemReferenceInputRepresentation) | The list of filter references mapped to filters section. | Required | 41.0 | | itemsPerRow | Integer | The number of filter items per row in the filter panel. | Optional | 41.0 | | showAllFilters | Boolean | Indicates whether all filters are displayed (true) or just one (false). | Optional | 41.0 | | showInViewMode | Boolean | Indicates whether the filter panel is displayed in view mode (true) or not (false). | Optional | 41.0 | | title | [FilterItemTitleInputRepresentation](#FilterPanelTitleInputRepresentation) | Indicates whether the filter panel is displayed in view mode (true) or not (false). | Optional | 41.0 | ## GlobalFiltersWidgetParametersInputRepresentation GlobalFiltersWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in GlobalFiltersWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | step | String | The step name tied to the widget. | Optional | 36.0 | ## ImageWidgetParametersInputRepresentation ImageWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in ImageWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`alignmentX`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Optional	37.0
`alignmentY`	ConnectWaveVerticalAlignmentEnum	The vertical alignment types. Valid values are: `Bottom` `Center` `Top`	Optional	37.0
`documentId`	String	The document ID of the image.	Required	37.0
`fit`	ConnectWaveImageFitTypeEnum	The image alignment types. Valid values are: `FitHeight` `FitWidth` `Original` `Stretch` `Tile`		37.0
`image`	AssetReferenceInputRepresentation	Image representation containing the name and namespace		39.0
`interactions`	InteractionInputRepresentation[]	A list of the interaction parameters for the widget.	Optional	58.0
`tooltip`	String	The tooltip the image.	Optional	42.0

## InheritWidgetParametersInputRepresentation InheritWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in InheritWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | step | String | The step name for this widget. | Required | 50.0 | ## InputWidgetParametersInputRepresentation InputWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in InputWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`activeValueColor`	String	The active color value for this widget.	Required	56.0
`currentValueColor`	String	The current color value for this widget.	Required	56.0
`displayFormat`	ConnectWaveInputWidgetDisplayFormatEnum	The display format of the input value. Valid values are: `Currency` `None` `Percent`	Required	56.0
`handleColor`	String	The handle color for this widget.	Required	56.0
`increments`	Object	The increments for this widget.	Required	56.0
`inputBackgroundColor`	String	The background color for this widget.	Required	56.0
`inputBorderColor`	String	The border color for this widget.	Required	56.0
`inputType`	ConnectWaveInputWidgetInputTypeEnum	The input type of the widget. Valid values are: `Slider` `Typein`	Required	56.0
`showCurrentValue`	Boolean	Indicates whether to show the current value of the widget (`true`) or not (`false`).	Required	56.0
`showValuesRange`	Boolean	Indicates whether to show the value range of the widget (`true`) or not (`false`).	Required	56.0
`step`	String	The step name for this widget.	Required	56.0
`title`	String	The title for this widget.	Required	56.0
`titleAlignment`	ConnectWaveHorizontalAlignmentEnum	The title alignment of the widget. Valid values are: `Center` `Left` `Right`	Required	56.0
`titleColor`	String	The title color for this widget.	Required	56.0
`titleFontSize`	Object	The title font size for this widget.	Required	56.0
`trackColor`	String	The track color for this widget.	Required	56.0
`valuesRangeColor`	String	The value range color for this widget.	Required	56.0

## LinkWidgetParametersInputRepresentation LinkWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in LinkWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`destination`	String	The destination of the link.	Optional	36.0
`destinationLink`	Object	The destination of the link.	Required	39.0
`destinationType`	ConnectWaveLinkWidgetDestTypeEnum	The type of asset the link refers to. Values are: `Dashboard` `Explore` `Lens` `Page` `Url`	Required	36.0
`fontSize`	Integer	The font size to be used for the widget.	Optional	36.0
`includeState`	Boolean	Indicates whether the state is included (`true`) or not (`false`).	Optional	36.0
`text`	String	The value of the text for the widget.	Optional	36.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Optional	39.0
`textColor`	String	The color of the text for the widget.	Optional	36.0
`visualizationType`	ConnectWaveVisualizationTypeEnum	The visualization type used for this widget. Valid values are: `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gantt` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	Optional	36.0

## ListSelectorWidgetParametersInputRepresentation ListSelectorWidgetParametersInputRepresentation inherits properties from the abstract [SelectorWidgetParametersInputRepresentation](#SelectorWidgetParametersInputRepresentation). These base properties appear in ListSelectorWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | compact | Boolean | Indicates whether the list selector is compact (true) or not (false). | Optional | 36.0 | | displayTemplate | String | The display template for widget level projection. | Optional | 39.0 | | expanded | Boolean | Value indicating whether the list selector is expanded (true) or not (false). | Optional | 36.0 | | exploreLink | Boolean | Indicates whether the list selector has an explore link (true) or not (false). | Optional | 36.0 | | interactions | [InteractionInputRepresentation](#InteractionInputRepresentation)\[\] | A list of interactions for the widget. | Optional | 64.0 | | measureField | String | The measure field this widget is applied on. | Optional | 36.0 | ## NavigationWidgetParametersInputRepresentation NavigationWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in NavigationWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fontSize | Integer | The value indicating the default font size for all the text in the navigation. | Optional | 43.0 | | selectedTab | [TabStyleParametersInputRepresentation](#TabStyleParametersInputRepresentation) | The selected tab styles for the widget. | Required | 43.0 | | tabCount | Integer | The number of tabs to show in the widget. | Optional | 43.0 | | textColor | String | The color value for the default tab text in the widget. | Optional | 43.0 | ## NumberWidgetParametersInputRepresentation NumberWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in NumberWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`compact`	Boolean	Indicates whether the widget is compact (`true`) or not (`false`).	Optional	36.0
`destinationLink`	Object	The destination link for the widget.	Optional	47.0
`exploreLink`	Boolean	Indicates whether the widget has an explore link (`true`) or not (`false`).	Optional	36.0
`fontSize`	Object	The font size of the text.	Optional	36.0
`interactions`	InteractionInputRepresentation[]	A list of the interaction parameters for the widget.	Optional	58.0
`measureField`	String	The measure field this number is calculated upon.	Optional	36.0
`noResultsLabel`	String	The text to display when no results are found.	Optional	45.0
`numberBold`	Object	The font weight of the number.	Optional	62.0
`numberColor`	String	The color of the number inside the widget.	Optional	36.0
`numberItalic`	Object	The font style of the number.	Optional	62.0
`numberSize`	Object	The size of the number.	Optional	36.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Optional	66.0
`step`	String	The step name tied to the widget.	Optional	36.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Optional	36.0
`textColor`	String	The color of the text inside the widget.	Optional	36.0
`title`	String	The title of the widget.	Optional	36.0
`titleBold`	Object	The font weight of the title.	Optional	62.0
`titleColor`	String	The color of the title for the widget.	Optional	36.0
`titleItalic`	Object	The font style of the title.	Optional	62.0
`titleSize`	Object	The size of the title text.	Optional	36.0
`tooltip`	TooltipInputRepresentation	The tooltip for the widget.	Optional	51.0

## PillBoxWidgetParametersInputRepresentation PillBoxWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in PillBoxWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | compact | Boolean | Indicates whether the widget is compact (true) or not (false). | Optional | 36.0 | | displayTemplate | String | The display template for widget level projection. | Optional | 39.0 | | exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Optional | 36.0 | | interactions | [InteractionInputRepresentation](#InteractionInputRepresentation)\[\] | A list of interactions for the widget. | Optional | 64.0 | | measureField | String | The measure field the widget is constructed upon. | Optional | 36.0 | | persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 | | step | String | The step name tied to the widget. | Optional | 36.0 | | title | String | The title of the widget. | Optional | 36.0 | ## RangeSelectorWidgetParametersInputRepresentation RangeSelectorWidgetParametersInputRepresentation inherits properties from the [SelectorWidgetParametersInputRepresentation](#SelectorWidgetParametersInputRepresentation). ## RepeaterWidgetParametersInputRepresentation RepeaterWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in RepeaterWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cardProperties | [RepeaterWidgetCardPropertiesInputRepresentation](#RepeaterWidgetCardPropertiesInputRepresentation) | The properties for a card for the widget. | Required | 53.0 | | cellProperties | Map | A map of repeater cell properties for the widget. | Required | 53.0 | | exploreLink | Boolean | Indicates whether to display the explorer link (true) or not (false). | Optional | 54.0 | | cellProperties | Map | A map of repeater header cell properties for the widget. | Optional | 64.0 | | interactions | [InteractionInputRepresentation](#InteractionInputRepresentation)\[\] | A list of the interaction parameters for the widget. | Optional | 57.0 | | itemsPerRow | Object | The number of cards per row of the widget. | Required | 53.0 | | persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Optional | 66.0 | | showHeader | Boolean | Indicates whether to display the header (true) or not (false). | Optional | 64.0 | | sortableColumns | Object | The sortable columns for the widget. | Optional | 59.0 | | step | String | The step name associated to the widget. | Required | 53.0 | ## TableWidgetParametersInputRepresentation TableWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in TableWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`assistiveText`	String	The assistive text for the widget.	Optional	64.0
`borderColor`	String	The outer border color for the widget.	Optional	41.0
`borderWidth`	Integer	The outer border width for the widget.	Optional	41.0
`cell`	TableWidgetCellParametersInputRepresentation	The cell properties for the widget.	Optional	41.0
`collapsible`	Boolean	Indicates whether the table is collapsible (`true`) or not (`false`).	Optional	50.0
`columnProperties`	Map<String, ColumnPropertiesInputsRepresentation>	The column properties for the widget.	Optional	42.0
`columnTotals`	Boolean	Indicates whether to display column totals in the table (`true`) or not (`false`).	Optional	55.0
`columnSubtotals`	Boolean	Indicates whether to display column subtotals in the table (`true`) or not (`false`).	Optional	56.0
`columns`	Object	The list of columns for the widget.	Required	41.0
`customBulkActions`	CustomBulkActionInputRepresentation[]	The list of custom bulk actions for the widget.	Optional	42.0
`enableAllDataFetch`	Boolean	Indicates whether all data is loaded (`true`) or data loading is paginated (`false`).	Optional	59.0
`evenRowColor`	String	The even row color for the widget.	Optional	41.0
`exploreLink`	Boolean	Indicates whether the widget has an explore link (`true`) or not (`false`).	Optional	38.0
`fixedColumnWidth`	Integer	The fixed column width for the widget.	Optional	40.0
`header`	TableWidgetCellParametersInputRepresentation	The header properties for the widget.	Required	41.0
`headerProperties`	HeaderPropertiesInputRepresentation	The header properties for the table columns in the widget.	Small, 64.0	64.0
`innerMajorBorderColor`	String	The inner major border color for the widget.	Optional	41.0
`innerMinorBorderColor`	String	The inner minor border color for the widget.	Optional	41.0
`interactions`	InteractionInputRepresentation[]	A list of the interaction parameters for the widget.	Optional	57.0
`maxColumnWidth`	Integer	The maximum column width for the widget.	Optional	40.0
`minColumnWidth`	Integer	The minimum column width for the widget.	Optional	40.0
`mode`	ConnectWaveTableModeEnum	The table mode for the widget. Valid values are: `FitToContainer` `Fixed` `Variable`	Optional	40.0
`numberOfFrozenColumns`	Integer	The number of frozen columns for the widget.	Optional	50.0
`numberOfLines`	Integer	The number of lines of text per row for the widget.	Optional	41.0
`oddRowColor`	String	The odd row color for the widget.	Optional	41.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Optional	66.0
`pivoted`	Boolean	Indicates whether to display the widget as pivot (`true`) or not (`false`).	Optional	39.0
`repeatGroupingRowValues`	Boolean	Indicates whether to repeat row values (`true`) or not (`false`).	Optional	66.0
`rowTotals`	Boolean	Indicates whether to display row totals in the table (`true`) or not (`false`).	Optional	55.0
`showRowIndexColumn`	Boolean	Indicates whether to show the row index column for the widget (`true`) or not (`false`).	Optional	41.0
`step`	String	The step name associated to the widget.	Required	38.0
`subtotals`	Boolean	Indicates whether to show the subtotals row for the widget (`true`) or not (`false`).	Optional	47.0
`totals`	Boolean	Indicates whether to show the totals row for the widget (`true`) or not (`false`).	Optional	40.0
`verticalPadding`	Integer	The cell vertical padding value for the widget.	Optional	41.0

## TextWidgetParametersInputRepresentation TextWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in TextWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`conditionalFormattingSource`	TextWidgetConditionalFormattingSourceInputRepresentation	The conditional formatting source for the widget.	Optional	57.0
`content`	DynamicDataInputRepresentation	The dynamic value of the text in the widget.	Required	49.0
`fontSize`	Object	The font size of the text.	Optional	36.0
`interactions`	InteractionInputRepresentation[]	A list of the interaction parameters for the widget.	Optional	57.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Optional	66.0
`text`	String	DEPRECATED The text for the widget.	Optional	36.0-48.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Optional	36.0
`textColor`	String	The color of the text.	Optional	36.0
`textOverflow`	ConnectWaveTextOverflowEnum	The overflow of the text. Valid values are: `Truncate` `Wrap`	Optional	60.0
`tooltip`	String	The tooltip for the widget.	Optional	42.0

## UrlWidgetParametersInputRepresentation UrlWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in UrlWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`type`	ConnectWaveUrlWidgetType	The type of URL for the widget. Valid values are: `YouTube`	Optional	36.0
`url`	String	The connect URL for the widget.	Optional	36.0
`videoSize`	String	The size of the video at which this URL points.	Optional	36.0

## ValuesTableWidgetParametersInputRepresentation ValuesTableWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in ValuesTableWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Optional | 36.0 | | hideHeaderColumn | Boolean | Indicating whether the header column is visible for the widget (true) or not (false). | Optional | 36.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Optional | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Optional | 36.0 | | step | String | The step name tied to the widget. | Optional | 36.0 | | totals | Boolean | Indicates whether the totals column is displayed (true) or not (false). | Optional | 36.0 | ## ImageParametersInputRepresentation ImageParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in ImageParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`alignmentX`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Optional	37.0
`alignmentY`	ConnectWaveVerticalAlignmentEnum	The vertical alignment types. Valid values are: `Bottom` `Center` `Top`	Optional	37.0
`altText`	String	The alternate text for the image.	Optional	55.0
`documentId`	String	The document id of the image.	Optional	37.0
`fit`	ConnectWaveImageFitTypeEnum	The image alignment types. Valid values are: Valid values are: `FitHeight` `FitWidth` `Original` `Stretch` `Tile`	Optional	37.0
`image`	AssetReferenceInputRepresentation	The image representation containing the name and the namespace.	Required	39.0
`tooltip`	String	The tooltip for the image.	Optional	42.0

## SelectorWidgetParametersInputRepresentation SelectorWidgetParametersInputRepresentation inherits properties from the abstract [WidgetParametersInputRepresentation](#WidgetParametersInputRepresentation). These base properties appear in SelectorWidgetParametersInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`displayMode`	ConnectWaveSelectorDisplayModeEnum	The display mode for dashboard selector widgets. Valid values are: `Combo` `Filter`	Required	46.0
`filterStyle`	FilterStyleInputRepresentation	The styling properties for filter widgets.	Optional	46.0
`instant`	Boolean	Indicates whether the list selector is instant (`true`) or not (`false`).	Optional	36.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Optional	66.0
`step`	String	The step name associated to the widget.	Required	36.0
`title`	String	The title of the widget.	Optional	36.0

## WidgetParametersInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`onboarding`	WidgetOnboardingInputRepresentation	The list of onboarding content for the widget.	Optional	46.0
`selectModeOverride`	ConnectWaveSelectModeEnum	The select mode types. Valid values are: Multi MultiRequired None Single SingleRequired	Optional	36.0
`showActionMenu`	Boolean	Indicates whether to display the widget action menu (`true`) or not (`false`).	Optional	44.0

## WidgetOnboardingInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | title | String | The title of the onboarding content. | Optional | 46.0 | | url | String | The URL of the onboarding content. | Required | 46.0 | ## WidgetPositionInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | h | String | The height of the widget. | Optional | 36.0 | | w | String | The width of the widget. | Optional | 36.0 | | x | Integer | The X index of widget. | Optional for PATCH, required for POST | 36.0 | | y | Integer | The Y index of widget. | Optional for PATCH, required for POST | 36.0 | | zIndex | Integer | The Z index of widget. | Optional | 36.0 | ## InteractionRepresentationInput

Property Name	Type	Description	Required or Optional	Available Version
`actions`	InteractionActionInputRepresentation[]	A list of the actions for the interaction. Valid actions types are: InteractionClearActionInputRepresentation InteractionFlowActionInputRepresentation InteractionNavigateActionInputRepresentation InteractionResetActionInputRepresentation	Required	57.0
`event`	ConnectWaveInteractionEventType	The event type for the interaction. Valid values are: `Click` `Select`	Required	57.0

## InteractionActionInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`type`	ConnectWaveInteractionActionTypeEnum	The action type for the interaction. Valid values are: `Clear` `Flow` `Navigate` `Reset` `Sort`	Required	60.0

## InteractionClearActionInputRepresentation InteractionClearActionInputRepresentation inherits properties from the abstract [InteractionActionInputRepresentation](#InteractionActionInputRepresentation). These base properties appear in InteractionClearActionInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`clearType`	ConnectWaveInteractionClearTypeEnum	The clear type for the interaction. Valid values are: `ClearAll` `ClearExclude` `ClearInclude`	Required	59.0
`lensIds`	String[]	A list of lens IDs for the interaction.	Required	59.0

## InteractionFlowActionInputRepresentation InteractionFlowActionInputRepresentation inherits properties from the abstract [InteractionActionInputRepresentation](#InteractionActionInputRepresentation). These base properties appear in InteractionFlowActionInputRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | Map | A map of interaction attributes. | Required | 58.0 | | name | String | The API name of the action. | Required | 58.0 | ## InteractionNavigateActionInputRepresentation + InteractionNaviaateActionInputRepresentation inherits properties from the abstract [InteractionActionInputRepresentation](#InteractionActionInputRepresentation). These base properties appear in InteractionNavigateActionInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`destinationLink`	Object	The destination link for the action.	Required	57.0
`destinationType`	ConnectWaveInteractionDestinationTypeEnum	The destination type for the action. Valid values are: `Component` `Dashboard` `Explore` `Lens` `Page` `Url`	Required	57.0
`goBack`	Boolean	Indicates whether to navigate back on deselection (`true`) or not (`false`).	Required	57.0

## InteractionResetActionInputRepresentation InteractionResetActionInputRepresentation inherits properties from the abstract [InteractionActionInputRepresentation](#InteractionActionInputRepresentation). These base properties appear in InteractionResetActionInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required	Available Version
`resetType`	ConnectWaveInteractionResetTypeEnum	The reset type for the action. Valid values are: `ResetFilters`	Required	58.0

## TextWidgetConditionalFormattingSourceInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | String | The field used to retrieve the conditional formatting for the widget. | Required | 57.0 | | scope | String | The scope of the conditional formatting rules for the widget | Required | 57.0 | | step | String | The step used to retrieve the conditional formatting rules for the widget | Required | 57.0 | ## FilterItemOptionsInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | The background color of the filter items. | Optional | 41.0 | | borderColor | String | The border color of the filter items. | Optional | 41.0 | | borderRadius | Integer | The border radius of the filter items. | Optional | 41.0 | | borderWidth | Integer | The border width of the filter items. | Optional | 41.0 | | propertyColor | String | The property color of the filter items. | Optional | 41.0 | | valueColor | String | The value color of the filter items. | Optional | 41.0 | ## FilterItemReferenceInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cdpObject | String | The Data 360 datasource in the filters section. | Required | 55.0 | | dataset | [AssetReferenceInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceInputRepresentation)\[\] | The dataset in the filters section. | Required | 46.0 | | dataspace | String | The name of datasapce for the Data 360 datasource in the filters section. | Optional | 62.0 | | field | String | The field in the filters section. | Required | 46.0 | | sObject | String | The sObject in the filters section. | Required | 55.0 | ## FilterPanelTitleInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | separatorColor | String | The filter panel's title separator color. | Optional | 41.0 | | text | [TextInputRepresentation](#TextInputRepresentation)\[\] | The filter panel's title text. | Required | 41.0 | | visible | Boolean | Indicates whether the filter panel's title is visible (true) or not (false). | Optional | 41.0 | ## TextInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`align`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Optional	41.0
`color`	String	The color of the text.	Optional	41.0
`fontSize`	Integer	The font size of the text.	Optional	41.0
`label`	String	The label for the text.	Required	41.0

## FilterStyleInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | titleColor | String | The color of the displayed title. | Required | 46.0 | | valueColor | String | The color for the displayed value. | Required | 46.0 | ## TabStyleParametersInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`backgroundColor`	String	The background color for the tab.	Optional	43.0
`borderColor`	String	The border color for the tab.	Optional	43.0
`borderEdges`	ConnectWaveBorderEdgeTypeEnum	The edges of the border to be drawn. Valid values are: All Bottom Left Right Top	Optional	43.0
`borderWidth`	Integer	The border width for the tab.	Optional	43.0
`textColor`	String	The text color for the selected tab.	Optional	43.0

## TooltipInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | content | [TooltipContentInputRepresentation](#TooltipContentInputRepresentation) | The content for the tooltip. | Required | 51.0 | | customizeTooltip | Boolean | Indicates whether the tooltip is customized (true) or not (false). | Required | 51.0 | | showTooltipTitle | Boolean | Indicates whether the tooltip title is visible (true) or not (false). | Optional | 62.0 | ## RepeaterWidgetCardPropertiesInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`cellSpacingX`	Integer	The horizontal spacing between grid cells.	Required	53.0
`cellSpacingY`	Integer	The vertical spacing between grid cells.	Required	53.0
`numColumns`	Integer	The number of columns for a repeater grid.	Required	53.0
`rowHeight`	ConnectWaveRowHeightEnum	Specifies the grid cell row height. Valid values are: Fine Normal	Required	53.0
`selectedStyles`	CardSelectionStyleParametersInputRepresentation	The styling for the selected repeater card of the widget	Required	54.0
`styles`	GridLayoutWidgetStyleInputRepresentation	The styling for the card of the widget	Required	53.0

## CardSelectionStyleParametersInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`backgroundColor`	String	The background color of selected card. Must be a 6 digit hex string.	Optional	54.0
`borderColor`	String	The border color of selected card. Must be a 6 digit hex string.	Optional	54.0
`borderEdges`	ConnectWaveBorderEdgeTypeEnum[]	The edges of the border to be drawn. Valid values are: All Bottom Left Right Top	Required	54.0
`borderRadius`	Integer	The border radius of selected card.	Optional	54.0
`borderWidth`	Integer	The border width of selected card.	Optional	54.0

## RepeaterWidgetCellPropertiesInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`parameters`	Object	The parameters of the cell, based on it's type.	Required	53.0
`position`	GridLayoutWidgetInputRepresentation	The cell position, dimension, and styles.	Required	53.0
`type`	ConnectWaveRepeaterCellTypeEnum	The cell type. Valid values are: `Image` (CellPropertiesImageParametersInputRepresentation) `Number (CellPropertiesNumberParametersInputRepresentation)` `Text (CellPropertiesTextParametersInputRepresentation)`	Required	53.0

## CellPropertiesImageParametersInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`alignmentX`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the image. Valid values are: `Center` `Left` `Right`	Required	54.0
`alignmentY`	ConnectWaveVerticalAlignmentEnum	The vertical alignment for the image. Valid values are: `Bottom` `Center` `Top`	Required	54.0
`altText`	String	The alternate text for the image.	Optional	54.0
`fit`	ConnectWaveImageFitTypeEnum	The fit type for the image. Valid values are: `FitHeight` `FitWidth` `Original` `Stretch` `Tile`	Required	54.0
`source`	Object	The source URL for the image.	Optional	54.0

## CellPropertiesNumberParametersInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`compact`	Boolean	Indicates whether compact form is on (`true`) or not (`false`).	Optional	54.0
`measureField`	String	The measure field this number is calculated from.	Required	54.0
`noResultsLabel`	String	The text to display when no results are found.	Optional	54.0
`numberBold`	Object	The font weight of the number.	Optional	62.0
`numberColor`	String	The color of the number.	Optional	54.0
`numberItalic`	Object	The font style of the number.	Optional	62.0
`numberSize`	Object	The size of the number.	Optional	54.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment for the text. Valid values are: `Center` `Left` `Right`	Required	54.0
`title`	String	The title of the widget.	Optional	54.0
`titleBold`	String	The font weight of the title.	Optional	62.0
`titleColor`	String	The color of the title.	Optional	54.0
`titleSize`	String	The size of the title.	Optional	54.0

## CellPropertiesTextParametersInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | conditionalFormattingSource | [TextWidgetConditionalFormattingSourceInputRepresentation](#TextWidgetConditionalFormattingSourceInputRepresentation) | The conditional formatting source for the text. | Optional | 57.0 | | content | [DynamicDataInputRepresentation](#DynamicDataInputRepresentation) | The dynamic value of the text. | Required | 54.0 | | interactions | [InteractionInputRepresentation](#InteractionInputRepresentation)\[\] | A list of interactions for the text. | Optional | 64.0 | | tooltip | [TooltipInputRepresentation](#TooltipInputRepresentation) | The tooltip for the text. | Optional | 57.0 | ## TableWidgetCellParametersInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`alignment`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the table cell. Valid values are: `Center` `Left` `Right`	Optional	62.0
`backgroundColor`	String	The background color of the cell.	Optional	41.0
`fontColor`	String	The color for the cell text font.	Optional	41.0
`fontSize`	Integer	The size for the cell text font.	Optional	41.0
`italic`	Boolean	Indicates whether the cell font style is italic (`true`) or not (`false`).	Optional	62.0
`textWrap`	Boolean	Indicates whether text wrapping is allowed (`true`) or not (`false`).	Optional	54.0
`underline`	Boolean	Indicates whether the cell font style is underlined (`true`) or not (`false`).	Optional	62.0

## ColumnPropertiesInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`parameters`	Object	The valid column parameters based on its type.	Required	42.0
`type`	ConnectWaveColumnRenderTypeEnum	The render types of a column. Valid values are: `Bar` (ColumnParametersBarInputRepresentation) `Image` (ColumnParametersImageInputRepresentation) `Text` (ColumnParametersTextInputRepresentation)	Required	41.0

## ColumnParametersBarInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | hideTotals | Object | The hide totals for the column. | Optional | 67.0 | | width | Integer | The width for the column. | Required | 54.0 | ## ColumnParametersImageInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`alignment`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the image. Valid values are: `Center` `Left` `Right`	Required	54.0
`height`	Integer	The image height for the image.	Required	54.0
`width`	Integer	The width for the column.	Required	54.0

## ColumnParametersTextInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`alignment`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the column. Valid values are: `Center` `Left` `Right`	Required	54.0
`hideTotals`	Object	The hide totals for the column.	Optional	67.0
`styles`	TextStyleInputRepresentation	The text style for the column.	Required	54.0
`width`	Integer	The width for the column.	Required	54.0

## TextStyleInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | bold | Boolean | Indicates whether the text is bold (true) or not (false). | Optional | 54.0 | | linkColor | String | The text color when the text is a link. | Optional | 54.0 | ## CustomBulkActionInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | label | String | Label for the custom action | | 39.0 | | visualforce | [AssetReferenceInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceInputRepresentation) | Visualforce page to invoke for the custom action | | 39.0 | ## DynamicDataInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | displayTemplate | String | The dynamic expression to resolve. | Required | 49.0 | | richTextContent | Map | Map to contain the data for the dynamic values. | Required | 49.0 | ## RichTextContentBlockInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | Map | Map of text attribute names and values. | Required | 52.0 | | insert | String | The text block content | Required | 52.0 | ## DynamicValueInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`compact`	Boolean	Indicates whether the resolved value is compact (`true`) or not (`false`).	Required	55.0
`field`	String	The column used to resolve the value.	Required	49.0
`noResultsLabel`	String	The text to display when no results are found.	Required	55.0
`sourceType`	ConnectWaveDynamicDataSourceType	The interaction type for the value. Valid values are: `Result` `Selection`	Required	49.0
`step`	String	The step id for the value.	Required	49.0

## TooltipContentInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | body | [TooltipVisualizationInputRepresentation](#TooltipVisualizationInputRepresentation) | The visualization for the tooltip. | Required | 51.0-52.0 | | description | [DynamicDataInputRepresentation](#DynamicDataInputRepresentation) | The text content for the tooltip. | Required | 51.0 | | widget | [TooltipWidgetInputRepresentation](#TooltipWidgetInputRepresentation) | The widget displayed in the tooltip. | Required | 53.0 | ## TooltipWidgetInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | height | Object | The height of the widget in the tooltip. | Required | 53.0 | | name | String | The name of the widget in the tooltip. | Required | 53.0 | | width | Object | The width of the widget in the tooltip. | Required | 53.0 | ## TooltipVisualizationInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | height | Object | The height for the tooltip. | Required | 51.0 | | source | [TypedAssetReferenceInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#TypedAssetReferenceInputRepresentation) | The source for the tooltip visualization. | Required | 51.0 | | width | Object | The width for the tooltip. | Required | 51.0 | ## TooltipSourceInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the tooltip source. | Required | 51.0 | | namespace | String | The namespace of the tooltip source. | Optional | 51.0 | | type | String | The type of the tooltip source. | Required | 51.0 | ## TooltipStyleInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | The background color of the tooltip. | Optional | 63.0 | | labelColor | String | The label color of the tooltip. | Optional | 63.0 | | valueColor | String | The value color of the tooltip. | Optional | 63.0 | ## HeaderPropertiesInputRepresentation | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | tooltip | [TableColumnHeaderTooltipInputRepresentation](#TableColumnHeaderTooltipInputRepresentation) | The tooltip for the table column header. | Required | 64.0 | ## TableColumnHeaderTooltipInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`sort`	TooltipModeEnum	The tooltip mode. Valid values are: `Custom` `Default` `None`	Required	64.0
`text`	String	The text for the tooltip.	Required	64.0

# Dashboard State Representation This page contains the reference for the DashboardStateRepresentation resource and all the representations that make up the dashboard state for API responses. The following representation details are not REST API endpoints on their own, but describe object representations used in REST API response bodies. ## DashboardStateRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`dataSourceLinks`	DashboardDataSourceLinkRepresentation[]	The list of all datasource links in a dashboard.	Small, 39.0	DEPRECATED 39.0-56.0
`dataSourceLinksInfo`	DashboardDataSourceLinksInfoRepresentation[]	The list of datasource links information used as part of the dashboard.	Small, 57.0	57.0
`filters`	FilterItemRepresentation[]	The list of datasource filters applied in this dashboard.	Small, 41.0	41.0
`gridLayouts`	GridLayoutRepresentation[]	The list of all grid layouts for this dashboard. This property replaces the 'layouts' property and the two are mutually exclusive.	Small, 36.0	36.0
`layouts`	LayoutRepresentation[]	DEPRECATED The list of layouts for this dashboard. The `gridLayouts` parameter replaces this list.	Small, 36.0	36.0
`parameters`	ParameterItemRepresentation[]	The list of parameters created for this dashboard.	Small, 58.0	58.0
`steps`	Map<String, StepRepresentation>	The map of steps used to create this dashboard. The key string is the step name. Valid step types are: AggregateFlexStepRepresentation AggregateStepRepresentation ApexStepRepresentation ApexStepQueryRepresentation CdpStepRepresentation DirectReportStepRepresentation ForecastingStepRepresentation GrainStepRepresentation HierarchyStepRepresentation InputStepRepresentation LensStepRepresentation MultiQueryStepRepresentation SqlStepRepresentation SaqlStepRepresentation SoqlStepRepresentation StaticFlexStepRepresentation StaticStepRepresentation	Small, 36.0	36.0
`widgetStyle`	GridLayoutWidgetStyleRepresentation	Default styling for widgets in this dashboard.	Small, 37.0	37.0
`widgets`	Map<String, DashboardWidgetRepresentation	The map of widgets used to create this dashboard. The key string is the widget name.	Small, 36.0	36.0

## DashboardDataSourceLinkRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [DashboardDataSourceFieldRepresentation](#DashboardDataSourceFieldRepresentation)\[\] | The list of fields connected in the data source link. | Small, 39.0 | 39.0 | | label | String | The label of the data source link. | Small, 39.0 | 39.0 | | name | String | The name of the data source link. | Small, 39.0 | 39.0 | ## DashboardDataSourceLinksInfoRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enableAutomaticLinking | Boolean | Indicates whether automatic linking is enabled for the dashboard (true) or not (false). | Small, 57.0 | 57.0 | | excludeRelationships | [DashboardDataSourceRelationshipRepresentation](#DashboardDataSourceRelationshipRepresentation)\[\] | The list of data source exclude relationships from faceting in the dashboard. | Small, 57.0 | 57.0 | | links | [DashboardDataSourceLinkRepresentation](#DashboardDataSourceLinkRepresentation)\[\] | The list of data source links for the dashboard. | Small, 57.0 | 57.0 | ## DashboardDataSourceRelationshipRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`fromDataSource`	String	The fully qualified name of the "from" data source.	Small, 57.0	57.0
`fromDataSourceType`	ConnectWaveDataSourceTypeEnum	The type of the "from" data source. Valid values are: `Apex` `Cdp` `Dataset` `Hierarchy` `ReportType` `Saql` `Sobject` `Static`	Small, 57.0	57.0
`toDataSource`	String	The fully qualified name of the "to" data source.	Small, 57.0	57.0
`toDataSourceType`	ConnectWaveDataSourceTypeEnum	The type of the "to" data source. Valid values are: `Apex` `Cdp` `Dataset` `Hierarchy` `ReportType` `Saql` `Sobject` `Static`	Small, 57.0	57.0

## DashboardDataSourceFieldRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`dataSourceName`	String	The datasource developer name.	Small, 39.0	39.0
`dataSourceNamespace`	String	The namespace that qualifies the dataset name	Small, 39.0	39.0
`dataSourceType`	ConnectWaveDataSourceTypeEnum	The type of datasource. Valid values are: `Apex` `Cdp` `Dataset` `Hierarchy` `ReportType` `Saql` `Sobject` `Static`	Small, 39.0	39.0
`dataspace`	String	The name of datasapce that the Data 360 object is assigned to.	Small, 62.0	62.0
`fieldName`	String	The name of field in the datasource.	Small, 39.0	39.0

## FilterItemRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | cdpObject | String | The Data 360 datasource the filter applies to. | Small, 55.0 | 55.0 | | dataset | [AssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceRepresentation) | The datasource to apply the filter to. | Small, 41.0 | 41.0 | | cdpObject | String | The Data 360 datasource in the filters section. | Small, 62.0 | 62.0 | | fields | String\[\] | The list of fields in filter. | Small, 41.0 | 41.0 | | hidden | Boolean | Indicates whether the filter is hidden in view mode (true) or not (false). | Small, 41.0 | 41.0 | | label | String | The label of the filter. | Small, 41.0 | 41.0 | | locked | Boolean | Indicates whether the filter is locked (true) or not (false). | Small, 41.0 | 41.0 | | operator | String | The operator for the filter. | Small, 41.0 | 41.0 | | sObject | String | The sObject datasource the filter applies to. | Small, 55.0 | 55.0 | | value | String | The value for the filter. | Small, 41.0 | 41.0 | ## GridLayoutWidgetStyleRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`backgroundColor`	String	The background color for the widget. This is a 6 character hex string. For example: #012345.	Small, 36.0	36.0
`borderColor`	String	The color of the widget's border. This is a 6 character hex string. For example: #012345.	Small, 36.0	36.0
`borderEdges`	ConnectWaveBorderEdgeTypeEnum[]	The edges of the border to be drawn. Valid values are: All Bottom Left Right Top	Small, 36.0	36.0
`borderRadius`	Object	The border radius of the widget.	Small, 36.0	36.0
`borderWidth`	Object	The width of the widget's border.	Small, 36.0	36.0
`bottomPadding`	Integer	The amount of padding on the bottom of the widget when rendered on mobile clients.	Small, 36.0	36.0
`leftPadding`	Integer	The amount of padding on the left of the widget when rendered on mobile clients.	Small, 36.0	36.0
`rightPadding`	Integer	The amount of padding on the right of the widget when rendered on mobile clients.	Small, 36.0	36.0
`tooltipStyle`	TooltipStyleRepresentation	The style for the dashboard tooltips.	Small, 63.0	63.0
`topPadding`	Integer	The amount of padding on the top of the widget when rendered on mobile clients.	Small, 36.0	36.0

## GridLayoutRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`maxWidth`	Integer	Add the ability for users to specify the maximum width that their dashboard can flex to.	Small, 38.0	38.0
`name`	String	The name of this layout.	Small, 36.0	36.0
`numColumns`	Integer	Add the number of columns for a dashboard grid layout that is customizable.	Small, 38.0	38.0
`pages`	GridLayoutPageRepresentation[]	The list of pages of widgets within the layout.	Small, 36.0	36.0
`rowHeight`	ConnectWaveRowHeightEnum	Specifies the grid cell row height. Valid values are: Fine Normal	Small, 39.0	39.0
`selectors`	String[]	The list of selectors this layout applies to.	Small, 36.0	36.0
`style`	GridLayoutStyleRepresentation	The styling for the layout.	Small, 37.0	37.0
`version`	Double	Version of this layout.	Small, 36.0	36.0
`widgetStyle`	GridLayoutWidgetStyleRepresentation	DEPRECATED The default styling for widgets within the layout.	Small, 36.0	36.0—37.0

## GridLayoutPageRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The display label for the page. | Small, 41.0 | 41.0 | | name | String | The unique id for a page within a layout. | Small, 41.0 | 41.0 | | navigationHidden | Boolean | Indicates whether the page is hidden in the navigation widget (true) or not (false). | Small, 44.0 | 44.0 | | widgets | [GridLayoutWidgetRepresentation](#GridLayoutWidgetRepresentation)\[\] | Widgets within the page. | Small, 36.0 | 36.0 | ## GridLayoutWidgetRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | backgroundImage | String | The background image for the widget. | Small, 36.0 | 36.0 | | colspan | Integer | The number of grid layout columns this widget spans. | Small, 36.0 | 36.0 | | column | Integer | The column where this widget is located. | Small, 36.0 | 36.0 | | name | String | The name of the widget. | Small, 36.0 | 36.0 | | row | Integer | The row where this widget is located. | Small, 36.0 | 36.0 | | rowspan | Integer | The number of grid layout rows this widget spans. | Small, 36.0 | 36.0 | | widgetStyle | [GridLayoutWidgetStyleRepresentation](#GridLayoutWidgetStyleRepresentation) | The style of the widget. | Small, 36.0 | 36.0 | ## GridLayoutStyleRepresentation GridLayoutStyleRepresentation inherits properties from the abstract [ImageParametersRepresentation](#ImageParametersRepresentation). These base properties appear in GridLayoutStyleRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | The background color for the layout. | Small, 36.0 | 36.0 | | cellSpacingX | Integer | The horizontal spacing between grid cells. | Small, 36.0 | 36.0 | | cellSpacingY | Integer | The vertical spacing between grid cells. | Small, 36.0 | 36.0 | | gutterColor | String | The gutter color for the layout. | Small, 36.0 | 36.0 | ## ParameterItemRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | defaultValue | Object | The default value of the parameter. | Small, 58.0 | 58.0 | | description | String | The description of the parameter. | Small, 58.0 | 58.0 | | label | String | The label of the parameter. | Small, 58.0 | 58.0 | | name | String | The name of the parameter. | Small, 58.0 | 58.0 | ## ImageParametersRepresentation ImageParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in ImageParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`alignmentX`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Small, 37.0	37.0
`alignmentY`	ConnectWaveVerticalAlignmentEnum	The vertical alignment types.Valid values are: `Bottom` `Center` `Top`	Small, 37.0	37.0
`documentId`	String	The document id of the image.	Small, 37.0	37.0
`fit`	ConnectWaveImageFitTypeEnum	The image alignment types. Valid values are: `FitHeight` `FitWidth` `Original` `Stretch` `Tile`	Small, 37.0	37.0
`image`	AssetReferenceRepresentation	The image representation containing the name and the namespace.	Small, v39.0	39.0

## LayoutRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`device`	ConnectWaveLayoutDeviceTypeEnum	The device rendering this dashboard. Valid values are: `Applewatch` `Default` `External` `Ipad` `Iphone`	Small, 36.0	36.0
`orientation`	ConnectWaveLayoutOrientationTypeEnum	The layout orientation of this dashboard. Valid values are: `Landscape` `Portrait`	Small, 36.0	36.0
`pages`	LayoutPageRepresentation[]	The list of layout pages available for the dashboard.	Small, 36.0	36.0
`version`	Double	The version of the layout for the dashboard.	Small, 36.0	36.0

## LayoutPageRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | rows | String\[\] | The rows associated with a layout page. | Small, 36.0 | 36.0 | ## AggregateStepRepresentation AggregateStepRepresentation inherits properties from the abstract [QueryStepRepresentation](#QueryStepRepresentation). These base properties appear in AggregateStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | isFacet | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 | ## AggregateFlexStepRepresentation AggregateFlexStepRepresentation inherits properties from the abstract [QueryStepRepresentation](#QueryStepRepresentation). These base properties appear in AggregateFlexStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 41.0 | 41.0 | | cdpObject | String | The name of the Data 360 object used for the query. | Small, 54.0 | 54.0-57.0 | | cdpObjects | String\[\] | A list of the Data 360 object names used for the query. | Small, 58.0 | 58.0 | | connectionName | String | The name of the connection used for steps powered by external data. | Small, 48.0 | 48.0 | | dataspace | String | The dataspace name for Data 360 objects. | Small, 61.0 | 61.0 | | receiveFacetSource | [ReceiveFacetSourceRepresentation](#ReceiveFacetSourceRepresentation) | The receive facet configurations. | Small, 41.0 | 41.0-47.0 | | sobject | String | The name of the sObject used for a SOQL query. | Small, 47.0 | 47.0 | | values | Map | A map of dynamic data values. | Small, 57.0 | 57.0 | ## ApexStepRepresentation ApexStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in ApexStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | query | [ApexStepQueryRepresentation](#ApexStepQueryRepresentation) | The queries to run for this step. | Small, 41.0 | 41.0 | ## CdpStepRepresentation CdpStepRepresentation inherits properties from the abstract [FlexMetadataStepRepresentation](#FlexMetadataStepRepresentation). These base properties appear in CdpStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 54.0 | 54.0 | | dataspace | String | The dataspace name for Data 360 objects. | Small, 61.0 | 61.0 | | query | String | The query for the step. | Small, 54.0 | 54.0 | | receiveFacetSource | [ReceiveFacetSourceRepresentation](#ReceiveFacetSourceRepresentation) | The receive facet source configuration | Small, 54.0 | 54.0 | | start | String | The start value for the step. | Small, 54.0 | 54.0 | | useLegacyCdpQueryApi | Boolean | Indicates whether this step uses the legacy Data 360 Query API (true) or not (false). | Small, 65.0 | 65.0 | | useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Small, 64.0 | 64.0 | | useGlobal | Boolean | Indicates whether this step is faceted to the global step (true) or not (false). | Small, 54.0 | 54.0 | | values | Map | A map of dynamic data values. | Small, 59.0 | 59.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for the step visualization. | Small, 54.0 | 54.0 | ## DirectReportStepRepresentation DirectReportStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in DirectReportStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 56.0 | 56.0 | | query | [DirectReportStepQueryRepresentation](#DirectReportStepQueryRepresentation) | The query to run for this step. | Small, 53.0 | 53.0 | | receiveFacetSource | [ReceiveFacetSourceRepresentation](#ReceiveFacetSourceRepresentation) | The receive facet configuration. | Small, 56.0 | 56.0 | | start | String | The start value for the step. | Small, 56.0 | 56.0 | | useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 56.0 | 56.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for the step visualization. | Small, 56.0 | 5.0 | ## ForecastingStepRepresentation ForecastingStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in ForecastingStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | query | [ForecastingStepQueryRepresentation](#ForecastingStepQueryRepresentation) | The query to run for this step. | Small, 59.0 | 59.0 | ## GrainStepRepresentation GrainStepRepresentation inherits properties from the abstract [QueryStepRepresentation](#QueryStepRepresentation). These base properties appear in GrainStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | isFacet | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 41.0 | 41.0 | | query | [ApexStepQueryRepresentation](#ApexStepQueryRepresentation) | The queries to run for this step. | Small, 41.0 | 41.0 | ## HierarchyStepRepresentation HierarchyStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in HierarchyStepRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`filterField`	String	The filter field to pass to the role hierarchy evaluation.	Small, 55.0	55.0
`hierarchyType`	HierarchyTypeEnum	The type of hierarchy used to facet. Valid values are: `ForecastHierarchy` `RoleHierarchy`	Small, 55.0	55.0
`query`	HierarchyStepQueryRepresentation	The query parameters to pass to the role hierarchy evaluation.	Small, 55.0	55.0

## HierarchyStepQueryRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | limit | Integer | The maximum amount of results to return for this step. | Small, 55.0 | 55.0 | ## InputStepRepresentation InputStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in InputStepRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`start`	String	The start value for the step.	Small, 56.0	56.0
`valueType`	ConnectWaveInputWidgetValueFormatEnum	The value type of the step. Valid values are: `Date` `Number` `Text`	Small, 56.0	56.0
`values`	InputStepValuesRepresentation[]	The list of values for the step.	Small, 56.0	56.0

## InputStepValuesRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | max | String | The max column in values. | Small, 56.0 | 56.0 | | min | String | The min column in values. | Small, 56.0 | 56.0 | ## LensStepRepresentation LensStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in LensStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source | [AssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceRepresentation) | The lens source for this step. | Small, 50.0 | 50.0 | ## MultiQueryStepRepresentation MultiQueryStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in MultiQueryStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | columns | [ColumnRepresentation](#ColumnRepresentation)\[\] | The list of queries to run for this step. | Small, 36.0 | 36.0 | | datasets | [AssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceRepresentation)\[\] | The list of datasets used by this step. | Small, 36.0 | 36.0 | | globalQuery | [Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_state.htm#Query)\[\] | The query override for all columns. | Small, 41.0 | 41.0 | | isFacet | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 41.0 | 41.0 | | isGlobal | Boolean | Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 | | sortable | Boolean | Indicates whether this step supports quick sorting in preview mode (true) or not (false). | Small, 64.0 | 64.0 | | start | String | The start value for the step. | Small, 36.0 | 36.0 | | useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Small, 64.0 | 64.0 | | useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 36.0 | 36.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for the step visualization. | Small, 36.0 | 36.0 | ## SqlStepRepresentation SqlStepRepresentation inherits properties from the abstract [FlexMetadataStepRepresentation](#FlexMetadataStepRepresentation). These base properties appear in SqlStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 51.0 | 51.0 | | connectionName | String | The name of the connection for the step. | Small, 51.0 | 51.0 | | query | String | The query for the step. | Small, 51.0 | 51.0 | | receiveFacetSource | [ReceiveFacetSourceRepresentation](#ReceiveFacetSourceRepresentation) | The receive facet configuration. | Small, 52.0 | 52.0 | | start | String | The start value for the step. | Small, 51.0 | 51.0 | | useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Small, 64.0 | 64.0 | | useGlobal | Boolean | Indicates whether this step is tied to the global step (true) or not (false). | Small, 53.0 | 53.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for the step visualization. | Small, 51.0 | 51.0 | ## SaqlStepRepresentation SaqlStepRepresentation inherits properties from the abstract [FlexMetadataStepRepresentation](#FlexMetadataStepRepresentation). These base properties appear in SaqlStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 41.0 | 41.0 | | query | String | The SAQL query for the step. | Small, 39.0 | 39.0 | | receiveFacetSource | [ReceiveFacetSourceRepresentation](#ReceiveFacetSourceRepresentation) | The receive facet source configuration | Small, 48.0 | 48.0 | | sortable | Boolean | Indicates whether this step supports quick sorting in preview mode (true) or not (false). | Small, 64.0 | 64.0 | | start | String | The start value for the step. | Small, 39.0 | 39.0 | | useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Small, 64.0 | 64.0 | | useGlobal | Boolean | Indicates whether this step is faceted to the global step. | Small, 39.0 | 39.0 | | values | Map | A map of dynamic data values. | Small, 57.0 | 57.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for the step visualization. | Small, 40.0 | 40.0 | ## SoqlStepRepresentation SoqlStepRepresentation inherits properties from the abstract [FlexMetadataStepRepresentation](#FlexMetadataStepRepresentation). These base properties appear in SoqlStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether the step broadcasts faceting (true) or not (false). | Small, 55.0 | 55.0 | | isFacet | Boolean | Indicates whether this step is faceted to other steps on the dashboard (true) or not (false). | Small, 39.0 | 39.0 | | query | String | The query for the step. | Small, 39.0 | 39.0 | | receiveFacetSource | [ReceiveFacetSourceRepresentation](#ReceiveFacetSourceRepresentation) | The receive facet source configuration. | Small, 55.0 | 55.0 | | start | String | The start value for the step. | Small, 39.0 | 39.0 | | useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Small, 64.0 | 64.0 | | useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 39.0 | 39.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for step visualization. | Small, 55.0 | 55.0 | ## StaticStepRepresentation StaticStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in StaticStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | datasets | [AssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceRepresentation)\[\] | The list of datasets used by this step. | Small, 36.0 | 36.0 | | dimensions | String\[\] | A list of dimensions for the step. | Small, 36.0 | 36.0 | | isFacet | Boolean | Indicates whether this step is faceted to other steps on the dashboard (true) or not (false). | Small, 36.0 | 36.0 | | isGlobal | Boolean | Indicates whether this step is a global filter which can be faceted to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 | | start | String | The start value for the step. | Small, 36.0 | 36.0 | | useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Small, 64.0 | 64.0 | | useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 36.0 | 36.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for the step visualization. | Small, 36.0 | 36.0 | ## StaticFlexStepRepresentation StaticFlexStepRepresentation inherits properties from the abstract [FlexMetadataStepRepresentation](#FlexMetadataStepRepresentation). These base properties appear in StaticFlexStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | broadcastFacet | Boolean | Indicates whether this step broadcasts faceting filters to other steps on the dashboard (true) or not (false). | Small, 41.0 | 41.0 | | columns | [StaticFlexStepColumnRepresentation](#StaticFlexStepColumnRepresentation) | The metadata about the columns used in values. | Small, 47.0 | 47.0 | | isGlobal | Boolean | Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 | | start | String | The start value for the step. | Small, 39.0 | 39.0 | | useExternalFilters | Boolean | Indicates whether this step uses external filters (true) or not (false). | Small, 64.0 | 64.0 | | useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 39.0 | 39.0 | | visualizationParameters | [StepVisualizationParametersRepresentation](#StepVisualizationParametersRepresentation) | The parameters for the step visualization. | Small, 40.0 | 40.0 | ## QueryStepRepresentation QueryStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in QueryStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | datasets | [AssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceRepresentation)\[\] | The list of datasets used by this step. | Small, 36.0 | 36.0 | | interactions | [InteractionRepresentation](#InteractionRepresentation)\[\] | A list of interactions for the widget. | Small, 64.0 | 64.0 | | isGlobal | Boolean | Indicates whether this step is a global filter which can be faced to other steps or widgets in the dashboard (true) or not (false). | Small, 36.0 | 36.0 | | query | [Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_state.htm#Query) | The query to run for this step. | Small, 36.0 | 36.0 | | sortable | Boolean | Indicates whether this step supports quick sorting in preview mode (true) or not (false). | Small, 64.0 | 64.0 | | start | String | The start value for the step. | Small, 36.0 | 36.0 | | useGlobal | Boolean | Indicates whether this step gets tied to the global step (true) or not (false). | Small, 36.0 | 36.0 | | visualizationParameters | StepVisualizationParametersRepresentation | The parameters for the step visualization. | Small, 36.0 | 36.0 | ## FlexMetadataStepRepresentation FlexMetadataStepRepresentation inherits properties from the abstract [StepRepresentation](#StepRepresentation). These base properties appear in FlexMetadataStepRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | groups | Object | The columns that are also groups. | Small, 39.0 | 39.0 | | numbers | Object | The number columns. | Small, 39.0 | 39.0 | | strings | Object | The string columns. | Small, 39.0 | 39.0 | ## StepRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`label`	String	The display label for the step.	Small, 36.0	36.0
`selectMode`	ConnectWaveSelectModeEnum	The select mode types. Valid values are: Multi MultiRequired None Single SingleRequired	Small, 36.0	36.0
`type`	ConnectWaveDashboardStepTypeEnum	The type of dashboard step. Valid values are: Aggregate AggregateFlex Apex Cdp DirectReport Discovery Forecasting Grain Hierarchy Lens Multi Saql Soql Sql Static StaticFlex Watchlist	Small, 36.0	36.0

## ApexStepQueryRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | body | Object | The body for the Apex request. | Small, 41.0 | 41.0 | | path | String | The path to the Apex controller. | Small, 41.0 | 41.0 | ## DirectReportStepQueryRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`metadata`	Object	The metadata for the query.	Small, 53.0	53.0
`mode`	DirectReportModeEnum	The query mode. Valid values are: `Aggregate` `Details` `Summary`	Small, 53.0	53.0
`reportId`	String	The ID for the query report.	Small, 53.0	53.0

## ForecastingStepQueryRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | forecastTypeId | String | The forecast type for the query. | Small, 59.0 | 59.0 | | startDate | Object | The start date for the query. | Small, 59.0 | 59.0 | | territoryId | String | The territory ID for the query. | Small, 59.0 | 59.0 | | userId | String | The user ID for the query. | Small, 59.0 | 59.0 | ## StaticFlexStepColumnRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`aggregateFunction`	String	The aggregate function for the column.	Small, 47.0	47.0
`dataset`	AssetReferenceRepresentation	The dataset used in the column.	Small, 47.0	47.0
`field`	String	The aggregate field for the column.	Small, 47.0	47.0
`type`	ConnectWaveDashboardStaticStepColumnTypeEnum	The column type. Valid values are String Number Grouping Aggregate	Small, 47.0	47.0

## StepVisualizationParametersRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`options`	LensVisualizationOptions	The configuration options for different lens visualizations. Valid values are: BarLensVisualizationOptions ComparisonTableLensVisualizationOptions DotLensVisualizationOptions HeatMapLensVisualizationOptions MatrixLensVisualizationOptions ParallelCoordsLensVisualizationOptions PieLensVisualizationOptions PivotTableLensVisualizationOptions ScatterLensVisualizationOptions StackedBarLensVisualizationOptions TableLensVisualizationOptions TimeLensVisualizationOptions ValuesTableLensVisualizationOptions	Small, 36.0	36.0
`parameters`	Object	Valid widget parameters based on its type.	Small, 40.0	40.0
`type`	ConnectWaveWidgetTypeEnum	The type of the widget. Valid values are: `Box` `Chart` `CompareTable` `Component` `Container` `DateSelector` `FilterPanel` `GlobalFilters` `Image` `Inherit` `Link` `ListSelector` `Navigation` `Number` `PillBox` `RangeSelector` `Repeater`> `Table` `Text` `Url` `ValuesTable`	Small, 40.0	40.0
`visualizationType`	String	The type of visualization. Valid values are: `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gantt` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	Small, 36.0	36.0

## ReceiveFacetSourceRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`mode`	ConnectWaveDashboardStepReceiveFacetModeTypeEnum	The type of receive facet mode. Valid values are: All Exclude Include None	Small, 48.0	48.0
`steps`	String[]	A list of steps that the current step receives or omits faceting from.	Small, 48.0	48.0

## DashboardWidgetRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`parameters`	Object	The valid widget parameters based on the type of widget. Parameter types include: BoxWidgetParametersRepresentation CompareTableWidgetParametersRepresentation ComponentWidgetParametersRepresentation ContainerWidgetParametersRepresentation DateSelectorWidgetParametersRepresentation FilterPanelWidgetParametersRepresentation GlobalFiltersWidgetParametersRepresentation ImageWidgetParametersRepresentation InheritWidgetParametersRepresentation InputWidgetParametersRepresentation LinkWidgetParametersRepresentation ListSelectorWidgetParametersRepresentation NavigationWidgetParametersRepresentation `NumberWidgetParametersRepresentation` PillBoxWidgetParametersRepresentation RangeSelectorWidgetParametersRepresentation RepeaterWidgetParametersRepresentation TableWidgetParametersRepresentation TextWidgetParametersRepresentation UrlWidgetParametersRepresentation ValuesTableWidgetParametersRepresentation	Small, 36.0	36.0
`position`	WidgetPositionRepresentation	The position information for the widget.	Small, 36.0	36.0
`type`	String	The type of the widget. Valid values are: `Box` `Chart` `CompareTable` `Component` `Container` `DateSelector` `FilterPanel` `GlobalFilters` `Image` `Inherit` `Link` `ListSelector` `Navigation` `Number` `PillBox` `RangeSelector` `Repeater`> `Table` `Text` `Url` `ValuesTable`	Small, 36.0	36.0

## BoxWidgetParametersRepresentation BoxWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in BoxWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | The background color of the widget. | Small, 36.0 | 36.0 | | borderColor | String | The border color of the widget. | Small, 36.0 | 36.0 | | imageUrl | String | A 15-character or 18-character Salesforce document ID. | Small, 36.0 | 36.0 | | stretch | Boolean | Indicates whether to stretch the widget. | Small, 36.0 | 36.0 | ## CompareTableWidgetParametersRepresentation CompareTableWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in CompareTableWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | exploreLink | Boolean | Indicates whether exploreLink is on (true) or not (false). | Small, 36.0 | 36.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 | | step | String | The step name tied to this widget. | Small, 36.0 | 36.0 | | totals | Boolean | Indicates whether to use totals. | Small, 36.0 | 36.0 | ## ComponentWidgetParametersRepresentation ComponentWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in ComponentWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | Object | The map of this component's attribute values. | Small, 51.0 | 51.0 | | dynamicAttributes | Object | The map of this component's dynamic attribute values. | Small, 59.0 | 59.0 | | pageName | String | The default page of this widget. | Small, 50.0 | 50.0 | | shareState | Boolean | Indicates whether this component widget shares state with the parent dashboard (true) or not (false). | Small, 51.0 | 51.0 | | source | [TypedAssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#TypedAssetReferenceRepresentation)\[\] | The component definition for this component widget. | Small, 46.0 | 46.0 | | step | String | The attached step for this component widget. | Small, 51.0 | 51.0 | ## ContainerWidgetParametersRepresentation ContainerWidgetParametersRepresentation inherits properties from the abstract [ImageParametersRepresentation](#ImageParametersRepresentation). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | interactions | [InteractionRepresentation](#InteractionRepresentation)\[\] | A list of the interaction parameters for the widget. | Small, 58.0 | 58.0 | ## DateSelectorWidgetParametersRepresentation DateSelectorWidgetParametersRepresentation inherits properties from the abstract [SelectorWidgetParametersRepresentation](#SelectorWidgetParametersRepresentation). These base properties appear in DateSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`absoluteModeEnabled`	Boolean	Indicates whether the widget has absolute mode enabled (`true`) or not (`false`).	Small, 43.0	43.0
`calendarTypeSwitchingAllowed`	Boolean	Indicates whether widget can switch calendar types (`true`) or not (`false`).	Small, 39.0	39.0
`customFilterPresets[]`	CustomFilterPresetTypeEnum	The list of custom preset filters. Valid values are: `AllTime` `CurrentFiscalQuarter` `CurrentFiscalQuarterToDate` `CurrentFiscalYear` `CurrentFiscalYearToDate` `CurrentMonth` `CurrentMonthToDate` `CurrentQuarter` `CurrentQuarterToDate` `CurrentWeek` `CurrentYear` `CurrentYearToDate` `Last180Days` `Last30Days` `Last7Days` `Last90Days` `Next180Days` `Next30Days` `Next7Days` `Next90Days` `NextFiscalQuarter` `NextFiscalYear` `NextMonth` `NextQuarter` `NextWeek` `NextYear` `PreviousFiscalQuarter` `PreviousFiscalQuarterToDate` `PreviousFiscalYear` `PreviousFiscalYearToDate` `PreviousFiscalMonth` `PreviousFiscalMonthToDate` `PreviousQuarter` `PreviousQuarterToDate` `PreviousWeek` `PreviousYear` `PreviousYearToDate`	Small, 54.0	54.0
`defaultFiscalMode`	Boolean	Indicates whether there is a default calendar type (`true`) or not (`false`).	Small, 39.0	39.0
`displayMode`	ConnectWaveSelectorDisplayModeEnum	The display mode for dashboard selector widgets. Valid values are: `Combo` `Filter`	Small, 46.0	46.0
`expanded`	Boolean	Indicates whether the selector widget is expanded (`true`) or not (`false`).	Small, 36.0	36.0
`presetsEnabled`	Boolean	Indicates whether the widget has presets enabled (`true`) or not (`false`).	Small, 43.0	43.0
`relativeModeEnabled`	Boolean	Indicates whether the widget has relative mode enabled (`true`) or not (`false`).	Small, 43.0	43.0

## FilterPanelWidgetParametersRepresentation FilterPanelWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in FilterPanelWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | filterItemOptions | [FilterItemOptionsRepresentation](#FilterItemOptionsRepresentation) | The filter items options. | Small, 41.0 | 41.0 | | filters | [FilterItemReferenceRepresentation](#FilterItemReferenceRepresentation) | The list of filter references mapped to the filters section. | Small, 46.0 | 46.0 | | itemsPerRow | Integer | The number of filter items per row in a filter panel. | Small, 41.0 | 41.0 | | showAllFilters | Integer | Indicates whether to display all the filters or just one filter. | Small, 46.0 | 46.0 | | showInViewMode | Boolean | Indicates whether the filter panel is displayed in view mode (true) or not (false). | Small, 41.0 | 41.0 | | title | [FilterPanelTitleRepresentation](#FilterPanelTitleRepresentation) | The filter panel title text. | Small, 41.0 | 41.0 | ## GlobaFiltersWidgetParametersRepresentation GlobalFiltersWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in GlobalFiltersWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | step | String | The step name tied to this widget. | Small, 36.0 | 36.0 | ## ImageWidgetParametersRepresentation ImageWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in ImageWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | altText | String | The alternate text for the image. | Samll, 55.0 | 55.0 | | decorative | Boolean | Indicates whether the image is decorative (true) or not (false). | Samll, 67.0 | 67.0 | | interactions | [InteractionRepresentation](#InteractionRepresentation)\[\] | A list of the interaction parameters for the widget. | Small, 57.0 | 57.0 | | tooltip | String | The tooltip for the image widget. | Small, 42.0 | 42.0 | ## InheritWidgetParametersRepresentation InheritWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in InheritWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | step | String | The step name for this widget. | Small, 50.0 | 50.0 | ## InputWidgetParametersRepresentation InputWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in InputWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`activeValueColor`	String	The active color value for this widget.	Small, 56.0	56.0
`currentValueColor`	String	The current color value for this widget.	Small, 56.0	56.0
`displayFormat`	ConnectWaveInputWidgetDisplayFormatEnum	The display format of the input value. Valid values are: `Currency` `None` `Percent`	Small, 56.0	56.0
`handleColor`	String	The handle color for this widget.	Small, 56.0	56.0
`increments`	Object	The increments for this widget.	Small, 56.0	56.0
`inputBackgroundColor`	String	The background color for this widget.	Small, 56.0	56.0
`inputBorderColor`	String	The border color for this widget.	Small, 56.0	56.0
`inputType`	ConnectWaveInputWidgetInputTypeEnum	The input type of the widget. Valid values are: `Slider` `Typein`	Small, 56.0	56.0
`showCurrentValue`	Boolean	Indicates whether to show the current value of the widget (`true`) or not (`false`).	Small, 56.0	56.0
`showValuesRange`	Boolean	Indicates whether to show the value range of the widget (`true`) or not (`false`).	Small, 56.0	56.0
`step`	String	The step name for this widget.	Small, 56.0	56.0
`title`	String	The title for this widget.	Small, 56.0	56.0
`titleAlignment`	ConnectWaveHorizontalAlignmentEnum	The title alignment of the widget. Valid values are: `Center` `Left` `Right`	Small, 56.0	56.0
`titleColor`	String	The title color for this widget.	Small, 56.0	56.0
`titleFontSize`	Object	The title font size for this widget.	Small, 56.0	56.0
`trackColor`	String	The track color for this widget.	Small, 56.0	56.0
`valuesRangeColor`	String	The value range color for this widget.	Small, 56.0	56.0

## LinkWidgetParametersRepresentation LinkWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in LinkWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`destination`	String	The destination of the link.	Small, 36.0	36.0
`destinationLink`	LinkDestinationRepresentation	The destination reference of this link. Valid values are: LinkAssetDestinationRepresentation LinkPageDestinationRepresentation LinkUrlDestinationRepresentation	Small, 39.0	39.0
`destinationType`	ConnectWaveLinkWidgetDestTypeEnum	The type of asset the link refers to. Values are: `Dashboard` `Explore` `Lens` `Page` `Url`	Small, 36.0	36.0
`fontSize`	Integer	The font size for the widget.	Small, 36.0	36.0
`includeState`	Boolean	Indicates whether to include the state.	Small, 36.0	36.0
`text`	String	The text value for the link.	Small, 36.0	36.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Small, 36.0	36.0
`textColor`	String	The text color for the widget.	Small, 36.0	36.0
`visualizationType`	String	The visualization type used for this widget. Valid values are: `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gantt` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	Small, 36.0	36.0

## ListSelectorWidgetParametersRepresentation ListSelectorWidgetParametersRepresentation inherits properties from the abstract [SelectorWidgetParametersRepresentation](#SelectorWidgetParametersRepresentation). These base properties appear in ListSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`compact`	Boolean	Indicates whether the list selector is compact (`true`) or not (`false`).	Small, 36.0	36.0
`displayMode`	ConnectWaveSelectorDisplayModeEnum	The display mode for dashboard selector widgets. Valid values are: `Combo` `Filter`	Small, 46.0	46.0
`displayTemplate`	String	Display template for widget level projection.	Small, 39.0	39.0
`expanded`	Boolean	Indicates whether the list selector is expanded (`true`) or not (`false`).	Small, 36.0	36.0
`exploreLink`	Boolean	Indicates whether the list selector has an explore link (`true`) or not (`false`).	Small, 36.0	36.0
`interactions`	InteractionRepresentation[]	A list of interactions for the widget.	Small, 64.0	64.0
`measureField`	String	The measure field associated with this widget.	Small, 36.0	36.0

## NavigationWidgetParametersRepresentation NavigationWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in NavigationWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fontSize | Integer | The value indicating the default font size for all the text in the navigation. | Small, 43.0 | 43.0 | | selectedTab | [TabStyleParametersRepresentation](#TabStyleParametersRepresentation) | The selected tab styles for the widget. | Small, 43.0 | 43.0 | | tabCount | Integer | The number of tabs to show in the widget. | Small, 43.0 | 43.0 | | textColor | String | The color value for the default tab text in the widget. | Small, 43.0 | 43.0 | ## NumberWidgetParametersRepresentation NumberWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in NumberWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`compact`	Boolean	Indicates whether the widget is compact (`true`) or not (`false`).	Small, 36.0	36.0
`destinationLink`	LinkDestinationRepresentation	The destination reference of the link.	Small, 47.0	47.0
`exploreLink`	Boolean	Indicates whether the widget has an explore link (`true`) or not (`false`).	Small, 36.0	36.0
`fontSize`	String	The font size of the widget text.	Small, 36.0	36.0
`interactions`	InteractionRepresentation[]	A list of the interaction parameters for the widget.	Small, 57.0	57.0
`measureField`	String	The measure field associated with the widget.	Small, 36.0	36.0
`noResultsLabel`	String	The text to display when no results are found.	Small, 45.0	45.0
`numberBold`	Object	The font weight of the number.	Small, 62.0	62.0
`numberColor`	String	The color of the number inside the widget.	Small, 36.0	36.0
`numberItalic`	Object	The font style of the number.	Small, 62.0	62.0
`numberSize`	Object	The size of the number inside the widget.	Small, 36.0	36.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Small, 66.0	66.0
`step`	String	The step name associated to the widget.	Small, 36.0	36.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Small, 36.0	36.0
`textColor`	String	The color of the text inside the widget.	Small, 36.0	36.0
`title`	String	The title of the widget.	Small, 36.0	36.0
`titleBold`	Object	The font weight of the title.	Small, 62.0	62.0
`titleColor`	String	The title color of the widget.	Small, 36.0	36.0
`titleItalic`	Object	The font style of the title.	Small, 62.0	62.0
`titleSize`	String	The title size of the widget.	Small, 36.0	36.0
`tooltip`	TooltipRepresentation	The tooltip for the widget.	Small, 51.0	51.0

## PillBoxWidgetParametersRepresentation PillBoxWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in PillBoxWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | compact | Boolean | Indicates whether the widget is compact (true) or not (false). | Small, 36.0 | 36.0 | | displayTemplate | String | The display template for widget level projection. | Small, 39.0 | 39.0 | | exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Small, 36.0 | 36.0 | | fontSize | String | The default font size for all items in the widget. | Small, 45.0 | 45.0 | | interactions | [InteractionRepresentation](#InteractionRepresentation)\[\] | A list of interactions for the widget. | Small, 64.0 | 64.0 | | measureField | String | The measure field associated with the widget. | Small, 36.0 | 36.0 | | persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Small, 66.0 | 66.0 | | selectedTab | [TabStyleParametersRepresentation](#TabStyleParametersRepresentation) | The selected tab styles for the widget. | Small, 45.0 | 45.0 | | step | String | The step name associated to the widget. | Small, 36.0 | 36.0 | | textColor | String | The color of the default text in the widget. | Small, 36.0 | 36.0 | | title | String | The title of the widget. | Small, 36.0 | 36.0 | ## RangeSelectorWidgetParametersRepresentation RangeSelectorWidgetParametersRepresentation inherits properties from the abstract [SelectorWidgetParametersRepresentation](#SelectorWidgetParametersRepresentation). These base properties appear in RangeSelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`displayMode`	ConnectWaveSelectorDisplayModeEnum	The display mode for dashboard selector widgets. Valid values are: `Combo` `Filter`	Small, 46.0	46.0

## RepeaterWidgetParametersRepresentation RepeaterWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in RepeaterWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | cardProperties | [RepeaterWidgetCardPropertiesRepresentation](#RepeaterWidgetCardPropertiesRepresentation) | The properties for a card for the widget. | Small, 53.0 | 53.0 | | cellProperties | Map | A map of repeater cell properties for the widget. | Small, 53.0 | 53.0 | | exploreLink | Boolean | Indicates whether to display the explorer link (true) or not (false). | Small, 54.0 | 54.0 | | headerCellProperties | Map | A map of repeater header cell properties for the widget. | Small, 64.0 | 64.0 | | interactions | [InteractionRepresentation](#InteractionRepresentation)\[\] | A list of the interaction parameters for the widget. | Small, 57.0 | 57.0 | | itemsPerRow | Object | The number of cards per row of the widget. | Small, 53.0 | 53.0 | | persistActionMenu | Boolean | Indicates whether to persist the actions menu (true) or not (false). | Small, 66.0 | 66.0 | | showHeader | Boolean | Indicates whether to display the header (true) or not (false). | Small, 64.0 | 64.0 | | sortableColumns | Object | The sortable columns for the widget. | Small, 59.0 | 59.0 | | step | String | The step name associated to the widget. | Small, 53.0 | 53.0 | ## TableWidgetParametersRepresentation TableWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in TableWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`assistiveText`	String	The assistive text for the widget.	Small, 64.0	64.0
`borderColor`	String	The outer border color for the widget.	Small, 41.0	41.0
`borderWidth`	Integer	The outer border width for the widget.	Small, 41.0	41.0
`cell`	TableWidgetCellParametersRepresentation	The cell properties for the widget.	Small, 41.0	41.0
`collapsible`	Boolean	Indicates whether the table is collapsible (`true`) or not (`false`).	Small, 50.0	50.0
`columnProperties`	ColumnPropertiesRepresentation	The column properties for the widget.	Small, 42.0	42.0
`columnSubtotals`	Boolean	Indicates whether to display column subtotals in the table (`true`) or not (`false`).	Small, 56.0	56.0
`columnTotals`	Boolean	Indicates whether to display column totals in the table (`true`) or not (`false`).	Small, 55.0	55.0
`columns`	Object	The columns for the widget.	Small, 41.0	41.0
`customBulkActions`	CustomBulkActionRepresentation	The custom bulk actions for the widget.	Small, 42.0	42.0
`enableAllDataFetch`	Boolean	Indicates whether all data is loaded (`true`) or data loading is paginated (`false`).	Small, 59.0	59.0
`evenRowColor`	String	The even row color for the widget.	Small, 41.0	41.0
`exploreLink`	Boolean	Indicates whether the widget has an explore link (`true`) or not (`false`).	Small, 38.0	38.0
`fixedColumnWidth`	Integer	The fixed column width for the widget.	Small, 40.0	40.0
`header`	TableWidgetCellParametersRepresentation	The header properties for the widget.	Small, 41.0	41.0
`headerProperties`	HeaderPropertiesRepresentation	The header properties for the table columns in the widget.	Small, 64.0	64.0
`innerMajorBorderColor`	String	The inner major border color for the widget.	Small, 41.0	41.0
`innerMinorBorderColor`	String	The inner minor border color for the widget.	Small, 41.0	41.0
`interactions`	InteractionRepresentation[]	A list of the interaction parameters for the widget.	Small, 57.0	57.0
`maxColumnWidth`	Integer	The maximum column width for the widget.	Small, 40.0	40.0
`minColumnWidth`	Integer	The minimum column width for the widget.	Small, 40.0	40.0
`mode`	ConnectWaveTableModeEnum	The table mode for the widget. Valid values are: `FitToContainer` `Fixed` `Variable`	Small, 40.0	40.0
`numberOfFrozenColumns`	Integer	The number of frozen columns for the widget.	Small, 50.0	50.0
`numberOfLines`	Integer	The number of lines of text per row for the widget.	Small, 41.0	41.0
`oddRowColor`	String	The odd row color for the widget.	Small, 41.0	41.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Small, 66.0	66.0
`pivoted`	Boolean	Indicates whether to display the widget as pivot (`true`) or not (`false`).	Small, 39.0	39.0
`repeatGroupingRowValues`	Boolean	Indicates whether to repeat row values (`true`) or not (`false`).	Small, 66.0	66.0
`rowTotals`	Boolean	Indicates whether to display row totals in the table (`true`) or not (`false`).	Small, 55.0	55.0
`showRowIndexColumn`	Boolean	Indicates whether to show the row index column for the widget (`true`) or not (`false`).	Small, 41.0	41.0
`step`	String	The step name associated to the widget.	Small, 38.0	38.0
`subtotals`	Boolean	Indicates whether to show the subtotals row for the widget (`true`) or not (`false`).	Small, 47.0	47.0
`totals`	Boolean	Indicates whether to show the totals row for the widget (`true`) or not (`false`).	Small, 40.0	40.0
`verticalPadding`	Integer	The cell vertical padding value for the widget.	Small, 41.0	41.0

## TextWidgetParametersRepresentation TextWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in TextWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`conditionalFormattingSource`	TextWidgetConditionalFormattingSourceRepresentation	The conditional formatting source for the widget.	Small, 57.0	57.0
`content`	DynamicDataRepresentation	The dynamic value of the text in the widget.	Small, 49.0	49.0
`fontSize`	Object	The font size of the text in the widget.	Small, 36.0	36.0
`interactions`	InteractionRepresentation[]	A list of the interaction parameters for the widget.	Small, 57.0	57.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Small, 66.0	66.0
`text`	String	DEPRECATED The value of the text in the widget.	Small, 36.0	36.0-48.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Small, 36.0	36.0
`textColor`	String	The color of the text in the widget.	Small, 36.0	36.0
`textOverflow`	ConnectWaveTextOverflowEnum	The overflow of the text. Valid values are: `Truncate` `Wrap`	Small, 60.0	60.0
`tooltip`	String	The tooltip for the widget.	Small, 42.0	42.0

## UrlWidgetParametersRepresentation UrlWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in UrlWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	ConnectWaveUrlWidgetType	The type of URL for the widget. Valid values are: `YouTube`	Small, 36.0	36.0
`url`	String	The URL for the widget.	Small, 36.0	36.0
`videoSize`	String	The size of the video the URL loads for the widget.	Small, 36.0	36.0

## ValueTableWidgetParametersRepresentation ValueTablesWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in ValueTablesWidgetParametersRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | exploreLink | Boolean | Indicates whether the widget has an explore link (true) or not (false). | Small, 36.0 | 36.0 | | hideHeaderLink | Boolean | Indicates whether the header column is hidden for this widget (true) or not (false). | Small, 36.0 | 36.0 | | maxColumnWidth | Integer | The maximum column width for the widget. | Small, 36.0 | 36.0 | | minColumnWidth | Integer | The minimum column width for the widget. | Small, 36.0 | 36.0 | | step | String | The step name associated to the widget. | Small, 36.0 | 36.0 | | totals | Boolean | Indicates whether to show the totals row for the widget (true) or not (false). | Small, 36.0 | 36.0 | ## WidgetParametersRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`onboarding`	WidgetOnboardingRepresentation	The value to indicate the widget onboarding content.	Small, 46.0	46.0
`selectModeOverride`	ConnectWaveSelectModeEnum	The select mode types. Valid values are: Multi MultiRequired None Single SingleRequired	Small, 36.0	36.0
`showActionMenu`	Boolean	Indicates whether to display the widget action menu (`true`) or not (`false`).	Small, 44.0	44.0

## WidgetOnboardingRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | title | String | The title of the onboarding content. | Small, 46.0 | 46.0 | | url | String | The URL of the onboarding content. | Small, 46.0 | 46.0 | ## SelectorWidgetParametersRepresentation SelectorWidgetParametersRepresentation inherits properties from the abstract [WidgetParametersRepresentation](#WidgetParametersRepresentation). These base properties appear in SelectorWidgetParametersRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`displayMode`	ConnectWaveSelectorDisplayModeEnum	The display mode for dashboard selector widgets. Valid values are: `Combo` `Filter`	Small, 46.0	46.0
`filterStyle`	FilterStyleRepresentation	The styling properties for filter widgets.	Small, 46.0	46.0
`instant`	Boolean	Indicates whether the list selector is instant (`true`) or not (`false`).	Small, 36.0	36.0
`persistActionMenu`	Boolean	Indicates whether to persist the actions menu (`true`) or not (`false`).	Small, 66.0	66.0
`step`	String	The step name associated to the widget.	Small, 36.0	36.0
`title`	String	The title of the widget.	Small, 36.0	36.0

## WidgetPositionRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | h | String | The height of the widget. | Small, 36.0 | 36.0 | | w | String | The width of the widget. | Small, 36.0 | 36.0 | | x | Integer | The x-index of the widget. | Small, 36.0 | 36.0 | | y | Integer | The y-index of the widget. | Small, 36.0 | 36.0 | | zIndex | Integer | The z-index of the widget. | Small, 36.0 | 36.0 | ## InteractionRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`actions`	InteractionActionRepresentation[]	A list of the actions for the interaction. Valid actions types are: InteractionClearActionRepresentation InteractionFlowActionRepresentation InteractionNavigateActionRepresentation InteractionResetActionRepresentation	Small, 57.0	57.0
`event`	ConnectWaveInteractionEventType	The event type for the interaction. Valid values are: `Click` `Select`	Small, 57.0	57.0

## InteractionActionRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`action`	ConnectWaveInteractionActionTypeEnum	The action type for the interaction. Valid values are: `Clear` `Flow` `Navigate` `Reset` `Sort`	Small, 57.0	57.0-59.0
`type`	ConnectWaveInteractionActionTypeEnum	The action type for the interaction. Valid values are: `Clear` `Flow` `Navigate` `Reset` `Sort`	Small, 60.0	60.0

## InteractionClearActionRepresentation InteractionClearActionRepresentation inherits properties from the abstract [InteractionActionRepresentation](#InteractionActionRepresentation). These base properties appear in InteractionClearActionRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`clearType`	ConnectWaveInteractionClearTypeEnum	The clear type for the interaction. Valid values are: `ClearAll` `ClearExclude` `ClearInclude`	Small, 59.0	59.0
`lensIds`	String[]	A list of lens IDs for the interaction.	Small, 59.0	59.0

## InteractionFlowActionRepresentation InteractionFlowActionRepresentation inherits properties from the abstract [InteractionActionRepresentation](#InteractionActionRepresentation). These base properties appear in InteractionFlowActionRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | Map | A map of interaction attributes. | Small, 58.0 | 58.0 | | name | String | The API name of the action. | Small, 58.0 | 58.0 | ## InteractionNavigateActionRepresentation InteractionNavigateActionRepresentation inherits properties from the abstract [InteractionActionRepresentation](#InteractionActionRepresentation). These base properties appear in InteractionNavigateActionRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`destinationLink`	LinkDestinationRepresentation	The destination link for the action.	Small, 57.0	57.0
`destinationType`	ConnectWaveInteractionDestinationTypeEnum	The destination type for the action. Valid values are: `Component` `Dashboard` `Explore` `Lens` `Page` `Url`	Small, 57.0	57.0
`goBack`	Boolean	Indicates whether to navigate back on deselection (`true`) or not (`false`).	Small, 57.0	57.0

## InteractionResetActionRepresentation InteractionResetActionRepresentation inherits properties from the abstract [InteractionActionRepresentation](#InteractionActionRepresentation). These base properties appear in InteractionResetActionRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`resetType`	ConnectWaveInteractionResetTypeEnum	The reset type for the action. Valid values are: `ResetFilters`	Small, 58.0	58.0

## TextWidgetConditionalFormattingSourceRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field | String | The field used to retrieve the conditional formatting for the widget. | Small, 57.0 | 57.0 | | scope | String | The scope of the conditional formatting rules for the widget | Small, 57.0 | 57.0 | | step | String | The step used to retrieve the conditional formatting rules for the widget | Small, 57.0 | 57.0 | ## FilterItemOptionsRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | The background color of the filter items. | Small, 41.0 | 41.0 | | borderColor | String | The border color of the filter items. | Small, 41.0 | 41.0 | | borderRadius | Integer | The border radius of the filter items. | Small, 41.0 | 41.0 | | borderWidth | Integer | The border width of the filter items. | Small, 41.0 | 41.0 | | propertyColor | String | The property color of the filter items. | Small, 41.0 | 41.0 | | valueColor | String | The value color of the filter items. | Small, 41.0 | 41.0 | ## FilterItemReferenceRepresentation FilterItemReferenceRepresentation inherits properties from the abstract [FilterRepresentation](#FilterRepresentation). These base properties appear in FilterItemReferenceRepresentation alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | cdpObject | String | The Data 360 datasource in the filters section. | Small, v55 | 55.0 | | dataset | [AssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceRepresentation)\[\] | The dataset in the filters section. | Small, 46.0 | 46.0 | | field | String | The field in the filters section. | Small, 46.0 | 46.0 | | sObject | String | The sObject in the filters section. | Small, v55 | 55.0 | ## FilterPanelTitleRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | separatorColor | String | The filter panel's title separator color. | Small, 41.0 | 41.0 | | text | [TextRepresentation](#TextRepresentation)\[\] | The filter panel's title text. | Small, 41.0 | 41.0 | | visible | Boolean | Indicates whether the filter panel's title is visible (true) or not (false). | Small, 41.0 | 41.0 | ## FilterRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | parameters | [FilterParamRepresentation](#FilterParamRepresentation)\[\] | The filter panel parameters. | Small, 41.0 | 41.0 | ## FilterParamRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | filter | String | The filter expression that specifies which records to include. | Small, 41.0 | 41.0 | | saqlFilter | String | The SAQL expression that specifies which records to include. | Small, 44.0 | 44.0 | ## LinkAssetDestinationRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the asset referenced by the link. | Small, 45.0 | 45.0 | | namespace | String | The namespace of the asset referenced by the link. | Small, 45.0 | 45.0 | | pageName | String | The page name for the link. | Small, 45.0 | 45.0 | | savedViewId | String | The dashboard saved view id for the link. | Small, 47.0 | 47.0 | | widgetId | String | The dashboard widget id for the link. | Small, 47.0 | 47.0 | ## LinkPageDestinationRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the page referenced by the link. | Small, 45.0 | 45.0 | ## LinkUrlDestinationRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`tooltip`	String	The tooltip for the link.	Small, 45.0	45.0
`tooltipMode`	TooltipModeEnum	The tooltip mode. The status of the readiness task. Valid values are: `Custom` `Default` `None`	Small, 62.0	62.0
`url`	String	The URL of the link.	Small, 45.0	45.0

## TabStyleParametersRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`backgroundColor`	String	The background color for the tab.	Small, 43.0	43.0
`borderColor`	String	The border color for the tab.	Small, 43.0	43.0
`borderEdges`	ConnectWaveBorderEdgeTypeEnum[]	The edges of the border to be drawn. Valid values are: All Bottom Left Right Top	Small, 43.0	43.0
`borderWidth`	Integer	The border width for the tab.	Small, 43.0	43.0
`textColor`	String	The text color for the selected tab.	Small, 43.0	43.0

## LinkDestinationRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | tooltip | String | The tooltip for the link. | Small, 46.0 | 46.0 | | url | String | The URL for the link. | Small, 43.0 | 43.0 | ## LinkMassActionDestinationRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | actionName | String | The name of the action. | Small, 51.0 | 51.0 | | field | String | The field name for the action. | Small, 51.0 | 51.0 | | step | String | The step to invoke the action on. | Small, 51.0 | 51.0 | ## TooltipRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | content | [TooltipContentRepresentation](#TooltipContentRepresentation) | The content for the tooltip. | Small, 51.0 | 51.0 | | customizeTooltip | Boolean | Indicates whether the tooltip is customized (true) or not (false). | Small, 51.0 | 51.0 | | showTooltipTitle | Boolean | Indicates whether the tooltip title is visible (true) or not (false). | Small, 62.0 | 62.0 | ## FilterStyleRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | titleColor | String | The color of the displayed title. | Small, 46.0 | 46.0 | | valueColor | String | The color for the displayed value. | Small, 46.0 | 46.0 | ## RepeaterWidgetCardPropertiesRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`cellSpacingX`	Integer	The horizontal spacing between grid cells.	Small, 53.0	53.0
`cellSpacingY`	Integer	The vertical spacing between grid cells.	Small, 53.0	53.0
`numColumns`	Integer	The number of columns for a repeater grid.	Small, 53.0	53.0
`rowHeight`	ConnectWaveRowHeightEnum	Specifies the grid cell row height. Valid values are: Fine Normal	Small, 53.0	53.0
`selectedStyles`	CardSelectionStyleParametersRepresentation	The styling for the selected repeater card of the widget	Small, 54.0	54.0
`styles`	GridLayoutWidgetStyleRepresentation	The styling for the repeater card of the widget	Small, 53.0	53.0

## CardSelectionStyleParametersRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`backgroundColor`	String	The background color of selected card. Must be a 6 digit hex string.	Small, 54.0	54.0
`borderColor`	String	The border color of selected card. Must be a 6 digit hex string.	Small, 54.0	54.0
`borderEdges`	ConnectWaveBorderEdgeTypeEnum[]	The edges of the border to be drawn. Valid values are: All Bottom Left Right Top	Small, 54.0	54.0
`borderRadius`	Integer	The border radius of selected card.	Small, 54.0	54.0
`borderWidth`	Integer	The border width of selected card.	Small, 54.0	54.0

## RepeaterWidgetCellPropertiesRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`parameters`	Object	The parameters of the cell, based on it's type.	Small, 53.0	53.0
`position`	GridLayoutWidgetRepresentation	The cell position, dimension, and styles.	Small, 53.0	53.0
`type`	ConnectWaveRepeaterCellTypeEnum	The cell type. Valid values are: `Image` (CellPropertiesImageParametersRepresentation) `Number (CellPropertiesNumberParametersRepresentation)` `Text (CellPropertiesTextParametersRepresentation)`	Small, 53.0	53.0

## CellPropertiesImageParametersRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`alignmentX`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the image. Valid values are: `Center` `Left` `Right`	Small, 54.0	54.0
`alignmentY`	ConnectWaveVerticalAlignmentEnum	The vertical alignment for the image. Valid values are: `Bottom` `Center` `Top`	Small, 54.0	54.0
`altText`	String	The alternate text for the image.	Small, 54.0	54.0
`fit`	ConnectWaveImageFitTypeEnum	The fit type for the image. Valid values are: `FitHeight` `FitWidth` `Original` `Stretch` `Tile`	Small, 54.0	54.0
`source`	Object	The source URL for the image.	Small, 54.0	54.0

## CellPropertiesNumberParametersRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`compact`	Boolean	Indicates whether compact form is on (`true`) or not (`false`).	Small, 54.0	54.0
`measureField`	String	The measure field this number is calculated from.	Small, 54.0	54.0
`noResultsLabel`	String	The text to display when no results are found.	Small, 54.0	54.0
`numberBold`	Object	The font weight of the number.	Small, 62.0	62.0
`numberColor`	String	The color of the number.	Small, 54.0	54.0
`numberItalic`	Object	The font style of the number.	Small, 62.0	62.0
`numberSize`	Object	The size of the number.	Small, 54.0	54.0
`textAlignment`	ConnectWaveHorizontalAlignmentEnum	The alignment for the text. Valid values are: `Center` `Left` `Right`	Small, 54.0	54.0
`title`	String	The title of the widget.	Small, 54.0	54.0
`titleBold`	String	The font weight of the title.	Small, 62.0	62.0
`titleColor`	String	The color of the title.	Small, 54.0	54.0
`titleSize`	String	The size of the title.	Small, 54.0	54.0

## CellPropertiesTextParametersRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | conditionalFormattingSource | [TextWidgetConditionalFormattingSourceRepresentation](#TextWidgetConditionalFormattingSourceRepresentation) | The conditional formatting source for the text. | Small, 57.0 | 57.0 | | content | [DynamicDataRepresentation](#DynamicDataRepresentation) | The dynamic value of the text. | Small, 53.0 | 53.0 | | interactions | [InteractionRepresentation](#InteractionRepresentation)\[\] | A list of interactions for the text. | Small, 64.0 | 64.0 | | tooltip | [TooltipRepresentation](#TooltipRepresentation) | The tooltip for the text. | Small, 57.0 | 57.0 | ## TableWidgetCellParametersRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`alignment`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the table cell. Valid values are: `Center` `Left` `Right`	Small, 62.0	62.0
`backgroundColor`	String	The background color of the cell.	Small, 41.0	41.0
`backgroundColor`	String	The background color of the cell.	Small, 41.0	41.0
`fontColor`	String	The color for the cell text font.	Small, 41.0	41.0
`fontSize`	Integer	The size for the cell text font.	Small, 41.0	41.0
`italic`	Boolean	Indicates whether the cell font style is italic (`true`) or not (`false`).	Small, 62.0	62.0
`textWrap`	Boolean	Indicates whether text wrapping is allowed (`true`) or not (`false`).	Small, 54.0	54.0
`underline`	Boolean	Indicates whether the cell font style is underlined (`true`) or not (`false`).	Small, 62.0	62.0

## ColumnPropertiesRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`parameters`	Object	The valid column parameters based on its type.	Small, 42.0	42.0
`type`	ConnectWaveColumnRenderTypeEnum	The render types of a column. Valid values are: `Bar` (ColumnParametersBarRepresentation) `Image` (ColumnParametersImageRepresentation) `Text` (ColumnParametersTextRepresentation)	Small, 41.0	41.0

## ColumnParametersBarRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | hideTotals | Object | The hide totals for the column. | Small, 67.0 | 67.0 | | width | Integer | The width for the column. | Small, 54.0 | 54.0 | ## ColumnParametersImageRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`alignment`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the image. Valid values are: `Center` `Left` `Right`	Small, 54.0	54.0
`height`	Integer	The image height for the image.	Small, 54.0	54.0
`width`	Integer	The width for the column.	Small, 54.0	54.0

## ColumnParametersTextRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`alignment`	ConnectWaveHorizontalAlignmentEnum	The horizontal alignment for the column. Valid values are: `Center` `Left` `Right`	Small, 54.0	54.0
`hideTotals`	Object	The hide totals for the column.	Small, 67.0	67.0
`styles`	TextStyleRepresentation	The text style for the column.	Small, 54.0	54.0
`width`	Integer	The width for the column.	Small, 54.0	54.0

## TextStyleRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | bold | Boolean | Indicates whether the text is bold (true) or not (false). | Small, 54.0 | 54.0 | | linkColor | String | The text color when the text is a link. | Small, 54.0 | 54.0 | ## CustomBulkActionRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The label for the custom action. | Small, 39.0 | 39.0 | | visualforce | [AssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#AssetReferenceRepresentation) | The VisualForce page to invoke for the custom action. | Small, 39.0 | 39.0 | ## TextRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`align`	ConnectWaveHorizontalAlignmentEnum	The alignment of the text. Valid values are: `Center` `Left` `Right`	Small, 41.0	41.0
`color`	String	The color of the text.	Small, 41.0	41.0
`fontSize`	Integer	The font size of the text.	Small, 41.0	41.0
`label`	String	The label for the text.	Small, 41.0	41.0

## ColumnRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`format`	ConnectWaveColumnFormatEnum	The column format value. Valid values are: `CurrencyCents` `CurrencyDollars` `Number` `Percentage`	Small, 36.0	36.0
`header`	String	The header text of this column.	Small, 36.0	36.0
`hidden`	Boolean	Indicates whether the column is hidden (`true`) or not (`false`).	Small, 36.0	36.0
`query`	Query	The SAQL used to create the comparison table.	Small, 36.0	36.0
`showBars`	Boolean	Indicates whether to show bars for the column (`true`) or not (`false`).	Small, 36.0	36.0
`sort`	ConnectWaveColumnSortEnum	The column sort order. Valid values are: `None` `Ascending` `Descending` `InnerAscending` `InnerDescending`	Small, 36.0	36.0

## DynamicDataRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | displayTemplate | String | The dynamic expression to resolve. | Small, 49.0 | 49.0 | | richTextContent | Map | Map to contain the data for the dynamic values. | Small, 49.0 | 49.0 | ## RichTextContentBlockRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | Map | Map of text attribute names and values. | Small, 52.0 | 52.0 | | insert | String | The text block content | Small, 52.0 | 52.0 | ## DynamicValueRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`compact`	Boolean	Indicates whether the resolved value is compact (`true`) or not (`false`).	Small, 55.0	55.0
`field`	String	The column used to resolve the value.	Small, 49.0	49.0
`noResultsLabel`	String	The text to display when no results are found.	Small, 55.0	55.0
`sourcecType`	ConnectWaveDynamicDataSourceType	The interaction type for the value. Valid values are: `Result` `Selection`	Small, 49.0	49.0
`step`	String	The step id for the value.	Small, 49.0	49.0

## TooltipContentRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | body | [TooltipVisualizationRepresentation](#TooltipVisualizationRepresentation) | The visualization for the tooltip. | Small, 51.0 | 51.0-52.0 | | description | [DynamicDataRepresentation](#DynamicDataRepresentation) | The text content for the tooltip. | Small, 51.0 | 51.0 | | widget | [TooltipWidgetRepresentation](#TooltipWidgetRepresentation) | The widget displayed in the tooltip. | Small, 53.0 | 53.0 | ## TooltipWidgetRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | height | Object | The height of the widget in the tooltip. | Small, 53.0 | 53.0 | | name | String | The name of the widget in the tooltip. | Small, 53.0 | 53.0 | | width | Object | The width of the widget in the tooltip. | Small, 53.0 | 53.0 | ## TooltipVisualizationRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | height | Object | The height for the tooltip. | Small, 51.0 | 51.0 | | source | [TypedAssetReferenceRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_appendix.htm#TypedAssetReferenceRepresentation) | The source for the tooltip visualization. | Small, 51.0 | 51.0 | | width | Object | The width for the tooltip. | Small, 51.0 | 51.0 | ## TooltipSourceRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the tooltip source. | Small, 51.0 | 51.0 | | namespace | String | The namespace of the tooltip source. | Small, 51.0 | 51.0 | | type | String | The type of the tooltip source. | Small, 51.0 | 51.0 | ## TooltipStyleRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | backgroundColor | String | The background color of the tooltip. | Small, 63.0 | 63.0 | | labelColor | String | The label color of the tooltip. | Small, 63.0 | 63.0 | | valueColor | String | The value color of the tooltip. | Small, 63.0 | 63.0 | ## HeaderPropertiesRepresentation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | tooltip | [TableColumnHeaderTooltipRepresentation](#TableColumnHeaderTooltipRepresentation) | The tooltip for the table column header. | Small, 54.0 | 64.0 | ## TableColumnHeaderTooltipRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`sort`	TooltipModeEnum	The tooltip mode. Valid values are: `Custom` `Default` `None`	Small, 64.0	64.0
`text`	String	The text for the tooltip.	Small, 54.0	64.0

# Dashboard Subscription Source The dashboard subscription source. Properties DashboardSubscriptionSource inherits properties from the abstract [SubscriptionSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_source.htm "The base Analytics subscription source."). These base properties appear in DashboardSubscriptionSource alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | asset | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The collection asset for the subscription. | Small, 53.0 | 53.0 | | savedView | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The dashboard saved view for the subscription. | Small, 54.0 | 54s.0 | # Dashboard Subscription Source Input The dashboard subscription source. Properties DashboardSubscriptionSourceInput inherits properties from the abstract [SourceDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_details_input.htm "The abstract source details for a subscription."). These base properties appear in DashboardSubscriptionSourceInput alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | asset | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The dashboard asset for the subscription. | Required | 53.0 | | savedView | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The saved view asset for the subscription. | Required | 54.0 | # Dashboard Widget Item Input The base dashboard widget item. Inherited by [SubscriptionWidgetInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_widget_input.htm "An Analytics widget subscription inherits properties from the base Dashboard Widget Item Input.") and [WatchlistItemMetadataInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_item_metadata_input.htm "The metadata for an Analytics watchlist item."). Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | destinationLink | Object | The link destination of the widget subscription. | Required | 47.0 | | state | [DashboardStateInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboard_state_input_rep.htm#DashboardStateInputRepresentation) | The state of the widget subscription. | Required | 47.0 | | title | String | The title of the widget subscription. | Required | 47.0 | | xmd | [XmdInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_input.htm "The extended metadata (Xmd) for an Analytics dataset version.") | The asset Xmd of the widget subscription. | Required | 47.0 | # Dashboards List Resource Returns a list of Analytics dashboard or creates a dashboard. ## Resource URL /wave/dashboards ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getDashboardCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-348611a2-5c12-4744-bc3e-cd2d4b2c57a2?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Aura — [ listDashboards()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods GET POST ## GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`folderId`	ID	Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder.	Optional	36.0
`ids`	String	Filters the results to include only the dashboards with the specified ids.	Optional	52.0
`mobileOnly`	Boolean	Filters the results for mobile enabled dashboards only.	Optional	41.0
`page`	String	A generated token that indicates the view of dashboard to be returned.	Optional	36.0
`pageSize`	Integer	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	36.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	36.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `CreatedByMe` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `App` `CreatedBy` `CreatedDate` `LastModified` `LastModifiedBy` `Mru` (Most Recently Used, last viewed date) `Name` `Type`	Optional	38.0
`templateApiName`	String	Filters the results to include only a collection of dashboards created from a specific application template	Optional	38.0
`type`	ConnectWaveAssetTypeEnum	The asset type. The default type is Dashboard. Valid types are: `Collection` `Component` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `Widget` `Workflow`	Optional, Small, 36.0	36.0

## GET Response Body [Dashboard Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_collection.htm "A collection of Analytics dashboards.") ## POST Request Body [Dashboard Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_input.htm "An Analytics dashboard.") ## POST Response Body [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard.htm "An Analytics dashboard.") # Data Cloud Extended Metadata Input The extended metadata (Xmd) for a Data 360 object data source for Analytics. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dataspace | String | The Data 360 data space the data object belongs to. Defaults to default if not specified. | Optional | 68.0 | | fields | [DataCloudFieldExtendedMetadataInput\[\]](bi_requests_data_cloud_field_extended_metadata_input.htm "The extended metadata (Xmd) for a field in Data 360 object.") | The list of fields for the data object. | Required | 68.0 | | objectName | String | The API name for the data object. | Required | 68.0 | # Data Cloud Extended Metadata Output The extended metadata (Xmd) for a Data 360 object data source for Analytics. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataspace | String | The Data 360 data space the data object belongs to. | Big, 68.0 | 68.0 | | fields | [DataCloudFieldExtendedMetadata\[\]](bi_responses_data_cloud_field_extended_metadata.htm "The extended metadata (Xmd) for a field in Data 360 object.") | The list of fields for the data object. | Big, 68.0 | 68.0 | | objectName | String | The API name for the data object. | Big, 68.0 | 68.0 | # Data Cloud Field Extended Metadata The extended metadata (Xmd) for a field in Data 360 object. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | developerName | String | The developer name for the data object field. | Big, 68.0 | 68.0 | | id | String | The ID for the data object field. | Big, 68.0 | 68.0 | | keyQualifier | String | The API name of the key qualifier field for the data object. This is null if not applicable. | Big, 68.0 | 68.0 | | label | String | The label for the data object field. | Big, 68.0 | 68.0 | | rollupable | Boolean | Indicates whether the data object field can be rolled up (true) or not (false). This is only for calculated insight objects (CIO). | Big, 68.0 | 68.0 | | type | String | The type of the data object field. | Big, 68.0 | 68.0 | | values | [DataCloudFieldValue\[\]](bi_responses_data_cloud_field_value.htm "A customized display value for a data object field.") | The list of customizations for the data object field values. | Big, 68.0 | 68.0 | # Data Cloud Field Extended Metadata Input The extended metadata (Xmd) for a field in Data 360 object. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | developerName | String | The developer name for the data object field. | Required | 68.0 | | label | String | The label for the data object field. | Required | 68.0 | | values | [DataCloudFieldValueInput\[\]](bi_requests_data_cloud_field_value_input.htm "A customized display value for a data object field.") | The list of customizations for the data object field values. | Required | 67.0 | # Data Cloud Field Value A customized display value for a data object field. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | color | String | The hexidecimal color code for the field value. | Big, 68.0 | 68.0 | | label | String | The custom display text for the field value. | Big, 68.0 | 68.0 | | value | String | The raw data value for the field. | Big, 68.0 | 68.0 | # Data Cloud Field Value Input A customized display value for a data object field. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | color | String | The hexidecimal color code for the field value. | Required | 68.0 | | label | String | The custom display text for the field value. | Required | 68.0 | | value | String | The raw data value for the field. | Required | 68.0 | # Data Cloud Objects Xmd Resource Returns and updates the extended metadata (XMD) that is associated with a Data 360 object, data model objects (DMO), data lake objects (DLO), and Calculated Insight Objects (CIO). ## Resource URL /analytics/data-cloud-objects//extended-metadata For full details on XMD, refer to the [Analytics Extended Metadata (XMD) Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_xmd.meta/bi_dev_guide_xmd/bi_xmd_intro.htm). ## Formats JSON ## Available Version 68.0 ## HTTP Methods GET PUT ## Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dataspace | String | The Data 360 data space the data object belongs to. | Required | 68.0 | | objectName | String | The API name of the data object to retrieve. | Required | 68.0 | ## Response Body for GET and PUT [Data Cloud Extended Metadata Output](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_cloud_extended_metadata_output.htm "The extended metadata (Xmd) for a Data 360 object data source for Analytics.") ## Request parameters for PUT | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dataCloudExtendedMetadataInputRepresentation | [DataCloudExtendedMetadataInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_cloud_extended_metadata_input.htm "The extended metadata (Xmd) for a Data 360 object data source for Analytics.") | The updated data object extended metadata. | Required | 68.0 | | objectName | String | The API name of the data object to update. | Required | 68.0 | # Data Connector An Analytics data connector. Properties DataConnector inherits properties from the abstract [BaseAssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_asset_reference.htm "The base Analytics asset."). These base properties appear in DataConnector alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`connectionProperties`	ConnectionPropertyValue[]	The connection properties. These are name and value pairs.	Small, 39.0	39.0
`connectorHandler`	ConnectWaveDataConnectorHandlerEnum	The connector handler associated with the Analytics connector. Valid values are: `Base` `Infa` `Legacy`	Small, 52.0	52.0
`connectorType`	ConnectWaveDataConnectorTypeEnum	The type of Analytics connector. Valid values are: `AmazonAthena` `AmazonRedshiftOutput` `AmazonS3` `AmazonS3Output` `AmazonS3Private` `AwsRdsAuroraMySQL` `AwsRdsAuroraPostgres` `AwsRdsMariaDB` `AwsRdsMySQL` `AwsRdsPostgres` `AwsRdsPostgresPrivate` `AwsRdsSqlServer` `AzureDataLakeGen2Output` `AzureSqlDatabase` `AzureSqlDatawarehouse` `Databricks (Beta)` `GoogleAnalytics4` `GoogleBigQuery` `GoogleBigQueryDirect` `GoogleBigQueryStandardSQL` `GoogleSpanner` `HerokuPostgres` `HubSpot` `MarketoV2` `NetSuite` `OracleEloqua` `Redshift` `RedshiftPrivate` `SalesforceExternal` `SalesforceMarketingCloudOAuth2` `SapHanaCloud` `SfdcLocal` `SnowflakeComputing` `SnowflakeDirect` `SnowflakeOutput` `SnowflakePrivate` `SnowflakePrivateOutput` `TableauOnline` `TableauHyperOutput` `Zendesk` .	Small, 39.0	39.0
`folder`	AssetReference	The folder for the live connection.	Small, 49.0	49.0
`ingestionSchedule`	Schedule	Schedule for the Analytics connector data sync.	Small, 43.0	43.0
`targetConnector`	AssetReference	The target connector associated with the current source connector.	Small, 50.0	50.0

Property Name	Type	Description	Required or Optional	Available Version
`connectionProperties`	DataConnectorPropertyInput[]	The list of connection properties for the Analytics connector.	Required for POST and PATCH (can be an empty list)	39.0
`connectorType`	ConnectWaveDataConnectorTypeEnum	For a full list of the data connector types, see the enum description.	Required for POST; Not allowed to edit in PATCH	39.0
`connectorHandler`	ConnectWaveDataConnectorHandlerEnum	The type of Analytics connector. Valid values are: `AmazonAthena` `AmazonRedshiftOutput` `AmazonS3` `AmazonS3Output` `AmazonS3Private` `AwsRdsAuroraMySQL` `AwsRdsAuroraPostgres` `AwsRdsMariaDB` `AwsRdsMySQL` `AwsRdsPostgres` `AwsRdsPostgresPrivate` `AwsRdsSqlServer` `AzureDataLakeGen2Output` `AzureSqlDatabase` `AzureSqlDatawarehouse` `Databricks (Beta)` `GoogleAnalytics4` `GoogleBigQuery` `GoogleBigQueryDirect` `GoogleBigQueryStandardSQL` `GoogleSpanner` `HerokuPostgres` `HubSpot` `MarketoV2` `NetSuite` `OracleEloqua` `Redshift` `RedshiftPrivate` `SalesforceExternal` `SalesforceMarketingCloudOAuth2` `SapHanaCloud` `SfdcLocal` `SnowflakeComputing` `SnowflakeDirect` `SnowflakeOutput` `SnowflakePrivate` `SnowflakePrivateOutput` `TableauOnline` `TableauHyperOutput` `Zendesk` .	Required for POST; Not allowed to edit in PATCH	52.0
`folder`	AssetReferenceInput	The folder for the live connector.	Optional	49.0
`targetConnector`	AssetReferenceInput	The target connector associated with the current source connector.	Optional	50.0

#### See Also - [Data Connector Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid.htm "Returns Analytics connector properties and updates or deletes Analytics connectors.") - [Data Connectors List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid.htm "Returns Analytics connector properties and updates or deletes Analytics connectors.") # Data Connector Property Input A property for an Analytics data connector. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the connection property. | Required | 39.0 | | value | Object | The value of the connection property. | Required | 39.0 | # Data Connector Resource Returns Analytics connector properties and updates or deletes Analytics connectors. ## Resource URL /wave/dataConnectors/ ## Formats JSON ## Available Version 39.0 ## Available in Postman To view and test a working example of this resource, see [getDataConnector](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-bb4b7379-80d5-46fc-9368-e7f15b040889?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDataConnector()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector.html) - LWC — [lightning/analyticsWaveApi updateDataConnector()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-data-connector.html) - LWC — [lightning/analyticsWaveApi deleteDataConnector()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-data-connector.html) ## HTTP Methods DELETE GET PATCH ## Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | userId | String | Retrieve the data connector with a user ID. | Optional | 55.0 | ## Response body for GET and PATCH [Data Connector](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector.htm "An Analytics data connector.") ## Request body for PATCH [Data Connector Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_connector_input.htm "An Analytics data connector.") The following JSON shows how to edit an existing Analytics connector. The name and connectorType can’t be changed after the Analytics connector is created, only the label, description, and connectionProperties. { "label": "My Salesforce External Connector", "description" : "Updated connection to another Salesforce org.", "connectionProperties" : \[ { "name" : "Password", "value" : "\*\*\*\*\*\*\*" }, { "name" : "Service\_URL", "value" : "https://MyDomainName.my.salesforce.com /services/Soap/u/41.0" }, { "name" : "Username", "value" : "user@yourSalesforceOrg.org" } \] } ## Schedule a Connection To schedule a connection, use the [Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm "Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync.") API. For examples of how to schedule dataflows, recipes, and data syncs, see [Schedule Dataflows, Recipes, and Data Syncs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#schedule_data_assets) # Data Connector Resources Data connectors are prebuilt connectors to quickly connect to data in your Salesforce orgs, apps, data warehouses, and database services. These resources allow users to manage data connectors and their source objects, run data syncs, and check statuses. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Data Connector List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors.htm "Returns a collection of Analytics connectors and creates an Analytics connector.") | Returns a collection of Analytics connectors and creates an Analytics connector. | GET POST | /wave/dataConnectors | | [Data Connector Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid.htm "Returns Analytics connector properties and updates or deletes Analytics connectors.") | Returns Analytics connector properties and updates or deletes Analytics connectors. | GET PATCH DELETE | /wave/dataConnectors/ | | [Data Connector Ingest Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_ingest.htm "Triggers the Analytics connector to run a data sync. This API is the equivalent of the “Run Now” UI feature.") | Triggers the Analytics connector to run a data sync. This API is the equivalent of the “Run Now” UI feature. | POST | /wave/dataConnectors//ingest | | [Data Connector Source Objects List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_sourceobjects.htm "Returns a list of all the source objects that are present under the specified Analytics connection.") | Returns a list of all the source objects that are present under the specified CRM Analytics connection. | GET | /wave/dataConnectors//sourceObjects | | [Data Connector Source Object Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_sourceobjects_sourceobjectname.htm "Returns a source object resource for an Analytics connector. A source object represents a specific category or type of data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets.") | Returns a source object resource for an Analytics connector. A source object represents a specific category or type of data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. | GET | /wave/dataConnectors//sourceObjects/ | | [Data Connector Source Object Data Preview Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connector_sourceobject_datapreview.htm "Returns a preview of the source object data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets.") | Returns a preview of the source object data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. | GET POST | /wave/dataConnectors//sourceObjects//dataPreview | | [Data Connector Source Object Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connector_sourceobject_fields.htm "Returns a list of source fields for a particular source object.") | Returns a list of source fields for a particular source object. | GET POST | /wave/dataConnectors//sourceObjects//fields | | [Data Connector Status Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_status.htm "Tests the status of an external Analytics connector. This API doesn't work to test a local Salesforce connector.") | Tests the status of an external Analytics connector. This API doesn't work to test a local Salesforce connector. | GET | /wave/dataConnectors//status | | [Data Connector Types Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectortypes.htm "Returns a collection of Analytics connector types.") | Returns a collection of Analytics connector types. | GET | /wave/dataConnectorTypes | - **[Data Connector Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid.htm)** Returns Analytics connector properties and updates or deletes Analytics connectors. - **[Data Connectors List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors.htm)** Returns a collection of Analytics connectors and creates an Analytics connector. - **[Data Connector Ingest Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_ingest.htm)** Triggers the Analytics connector to run a data sync. This API is the equivalent of the “Run Now” UI feature. - **[Data Connector Source Objects List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_sourceobjects.htm)** Returns a list of all the source objects that are present under the specified Analytics connection. - **[Data Connector Source Object Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_sourceobjects_sourceobjectname.htm)** Returns a source object resource for an Analytics connector. A source object represents a specific category or type of data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. - **[Data Connector Source Object Data Preview Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connector_sourceobject_datapreview.htm)** Returns a preview of the source object data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. - **[Data Connector Source Object Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connector_sourceobject_fields.htm)** Returns a list of source fields for a particular source object. - **[Data Connector Status Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_status.htm)** Tests the status of an external Analytics connector. This API doesn't work to test a local Salesforce connector. - **[Data Connector Types Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectortypes.htm)** Returns a collection of Analytics connector types. # Data Connector Source Object Data Preview Resource Returns a preview of the source object data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. ## Resource URL /wave/dataConnectors//sourceObjects//dataPreview ## Formats JSON ## Available Version 40.0 ## Available Components - LWC — [lightning/analyticsWaveApi getDataConnectorSourceObjectDataPreviewWithFields()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-source-object-data-previewwithfields.html) ## HTTP Methods GET POST ## Request body for POST [Source Object Data Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_object_data_input.htm "The request to retrieve data from a source object given a list of fields and advanced properties.") The following JSON shows a POST request for fields to return in the source object data preview. At least one field value must be specified in the list. { "sourceObjectFields": \["Id", "Name"\] } ## Response body for GET and POST [Source Object Data](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object_data.htm "The data retrieved from a source object given a list of fields and advanced properties.") The following JSON is an example response body. { "dataListJson": { "records": \[ {"Id": "xxxxxxxxx1", "Name": "Record Name One"}, {"Id": "xxxxxxxxx2", "Name": "Record Name Two"} \] }, "url": "/services/data/v48.0/wave/dataConnectors/0ItS7000000xxxxxx/sourceObjects//dataPreview" } # Data Connector Source Object Fields Resource Returns a list of source fields for a particular source object. ## Resource URL /wave/dataConnectors//sourceObjects//fields ## Formats JSON ## Available Version GET - 37.0, POST - 67.0 ## Available Components - LWC — [lightning/analyticsWaveApi getDataConnectorSourceFields()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-source-fields.html) ## HTTP Methods GET POST ## Response body for GET [Source Field Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_field_collection.htm "A collection of fields for a source object.") ## POST Request Body [Source Object Data Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_object_data_input.htm "The request to retrieve data from a source object given a list of fields and advanced properties.") # Data Connector Source Object Resource Returns a source object resource for an Analytics connector. A source object represents a specific category or type of data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets. ## Resource URL /wave/dataConnectors//sourceObjects/ ## Formats JSON ## Available Version 37.0 ## Available Components - LWC — [lightning/analyticsWaveApi getDataConnectorSourceObject()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-source-object.html) ## HTTP Methods GET ## Response body for GET [Source Object](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object.htm "A source object for an Analytics data connector.") # Data Connector Source Objects List Resource Returns a list of all the source objects that are present under the specified Analytics connection. Resource URL /wave/dataConnectors//sourceObjects Formats JSON Available Version 37.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | page | String | A generated token that indicates the view of the objects to be returned. | Optional | 37.0 | | pageSize | Int | Number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. | Optional | 37.0 | | q | String | Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. | Optional | 54.0 | Response body for GET [Source Object Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object_collection.htm "A collection of source objects for an Analytics data connector.") # Data Connector Status The status for an Analytics data connector. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`message`	String	Message from testing a connection status.	Small, 45.0	45.0
`status`	ConnectWaveDataConnectorStatusEnum	Result from testing the Analytics connector. Valid values are: `Failure` `Success`	Small, 45.0	45.0
`url`	String	The URL for the data connector status.	Small, 45.0	45.0

#### See Also - [Data Connector Status Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_status.htm "Tests the status of an external Analytics connector. This API doesn't work to test a local Salesforce connector.") # Data Connector Status Resource Tests the status of an external Analytics connector. This API doesn't work to test a local Salesforce connector. ## Resource URL /wave/dataConnectors//status ## Formats JSON ## Available Version 45.0 ## Available in Postman To view and test a working example of this resource, see [getDataConnectorStatus](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-a1f138d6-1004-4e95-8257-950ff26bdc4d?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDataConnectorStatus()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-status.html) ## HTTP Methods GET ## Response body for GET [Data Connector Status](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_status.htm "The status for an Analytics data connector.") # Data Connector Type An Analytics data connector type. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`advancedProperties`	AdvancedProperty[]	The advanced properties of the Analytics connector type.	Small, 45.0	45.0
`associatedCategories`	ConnectWaveConnectorCategoryEnum	The categories that the data connector belongs to. Valid values are: `AdvancedPropertiesSupport` `BatchRead` `Direct` `FileBased` `FilterSupport` `Output` `Private`	Small, 49.0	49.0
`bundle`	ConnectWaveDataConnectorBundleEnum	The bundle type that the data connector belongs to. Valid values are: `AmazonRedshift` `AmazonS3` `Azure` `Cdp` `Salesforce` `Snowflake` `Tableau`	Small, 53.0	53.0
`connectionProperties`	ConnectionProperty[]	The connection properties of the Analytics connector type.	Small, 39.0	39.0
`isExternal`	Boolean	Indicates whether the Analytics connector type is external (`true`) or internal (`false`).	Small, 39.0	39.0
`label`	String	The label of the Analytics connector type.	Small, 39.0	39.0
`name`	String	The name of the Analytics connector type.	Small, 39.0	39.0
`supportedConnectorHandlers`	ConnectWaveDataConnectorHandlerEnum[]	The list of supported connector handlers for the Analytics connector type. Valid values are: `Base` `Legacy`	Small, 52.0	52.0
`type`	ConnectWaveDataConnectorTypeEnum	The type of Analytics connector. Valid values are: `AmazonAthena` `AmazonRedshiftOutput` `AmazonS3` `AmazonS3Output` `AmazonS3Private` `AwsRdsAuroraMySQL` `AwsRdsAuroraPostgres` `AwsRdsMariaDB` `AwsRdsMySQL` `AwsRdsPostgres` `AwsRdsPostgresPrivate` `AwsRdsSqlServer` `AzureDataLakeGen2Output` `AzureSqlDatabase` `AzureSqlDatawarehouse` `Databricks (Beta)` `GoogleAnalytics4` `GoogleBigQuery` `GoogleBigQueryDirect` `GoogleBigQueryStandardSQL` `GoogleSpanner` `HerokuPostgres` `HubSpot` `MarketoV2` `NetSuite` `OracleEloqua` `Redshift` `RedshiftPrivate` `SalesforceExternal` `SalesforceMarketingCloudOAuth2` `SapHanaCloud` `SfdcLocal` `SnowflakeComputing` `SnowflakeDirect` `SnowflakeOutput` `SnowflakePrivate` `SnowflakePrivateOutput` `TableauOnline` `TableauHyperOutput` `Zendesk` .	Small, 39.0	39.0

# Data Connector Type Collection A collection of Analytics data connector types. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | types | [DataConnectorType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_type.htm "An Analytics data connector type.")\[\] | A list of Analytics connector types. | Small, 39.0 | 39.0 | | url | String | The URL to get the collection. | Small, 39.0 | 39.0 | #### See Also - [Data Connector Types Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectortypes.htm "Returns a collection of Analytics connector types.") # Data Connector Types Resource Returns a collection of Analytics connector types. ## Resource URL /wave/dataConnectorTypes ## Formats JSON ## Available Version 39.0 ## Available in Postman To view and test a working example of this resource, see [getDataConnectorTypeCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-abbc8b13-cfd5-4a13-b670-0e3371094b35?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDataConnectorTypes()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connector-types.html) ## HTTP Methods GET ## Response body for GET [Data Connector Type Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_type_collection.htm "A collection of Analytics data connector types.") # Data Connectors List Resource Returns a collection of Analytics connectors and creates an Analytics connector. ## Resource URL /wave/dataConnectors ## Formats JSON ## Available Version 39.0 ## Available in Postman To view and test a working example of this resource, see [getDataConnectorCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-5a36e087-493b-43b2-9387-ee5b5c8fd589?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDataConnectors()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-data-connectors.html) - LWC — [lightning/analyticsWaveApi createDataConnector()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-data-connector.html) ## HTTP Methods GET POST ## Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`category`	ConnectWaveConnectorCategoryEnum	The categories that the data connector belongs to. Valid values are: `AdvancedPropertiesSupport` `BatchRead` `Direct` `FileBased` `FilterSupport` `Output` `Private`	Optional	49.0
`connectorType`	ConnectWaveDataConnectorTypeEnum	For a full list of the data connector types, see the enum description.	Optional	39.0
`folderId`	Id	Filters the results to include on the contents of a specific folder. The id can be the requesting user's ID for items in the user's private folder.	Optional	49.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `Browse` `CreatedByMe` `InsightsApplicationsIsCansEdit` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0

## Response body for GET [Data Connector Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector_collection.htm "A collection of Analytics data connectors.") ## Request body for POST [Data Connector Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_data_connector_input.htm "An Analytics data connector.") The following JSON shows how to create a new Analytics connector, of connectorType SalesforceExternal. { "label": "My SalesforceExternal Connector", "name" : "mySFDCExt", "description" : "Connection to another Salesforce org.", "connectorType" : "SalesforceExternal", "connectorHandler" : "Legacy", "connectionProperties" : \[ { "name" : "Password", "value" : "\*\*\*\*\*\*\*" }, { "name" : "Service\_URL", "value" : "https://MyDomainName.my.salesforce.com /services/Soap/u/53.0" }, { "name" : "Username", "value" : "user@yourSalesforceOrg.org" }, { "name" : "APIType", "value" : "BULKV2" } \] } ## Response body for POST [Data Connector](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_data_connector.htm "An Analytics data connector.") # Data Lake Object Field Type The data lake object field type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable.").

Property Name	Type	Description	Filter Group and Version	Available Version
`dataType`	String	The data lake object field data type when a default field isn't supplied. Valid values are: string number date_time date	Small, 58.0	58.0

# Data Lake Object Type The data lake object type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). # Data Model Object Field Type The data model object field type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable.").

Property Name	Type	Description	Filter Group and Version	Available Version
`dataType`	String	The data model object field data type when a default field isn't supplied. Valid values are: string number date_time date	Small, 58.0	58.0

# Data Model Object Type The data model object type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). # Dataflow An Analytics dataflow. Properties Dataflow inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear alongside Dataflow specific properties in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`definition`	Object	The representation of the dataflow nodes.	Small, 50.0	50.0
`emailNotificationLevel`	ConnectEmailNotificationLevelEnum	Valid types of email notification levels you can set. Valid values are: `Always` `Failures` `Never` `Warnings`	Small, 42.0	42.0
`historiesUrl`	String	The URL that retrieves the dataflow histories associated with this dataflow.	Small, 46.0	46.0
`nextScheduledDate`	Date	The time of the next scheduled run, in ISO8601 date format.	Small, 42.0	42.0
`scheduleAttributes`	String	The schedule details for the dataflow, which includes the frequency and start time.	Small, 42.0	42.0

#### See Also - [Dataflow Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm "Returns a dataflow. Reverts a dataflow to a previous version.") # Dataflow Collection A collection of Analytics dataflows. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataflows | [Dataflow](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow.htm "An Analytics dataflow.")\[\] | A collection of dataflows. | Small, 37.0 | 37.0 | #### See Also - [Dataflows List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows.htm "Returns a collection of dataflows.") # Dataflow Input An Analytics dataflow. Properties DataflowInput inherits properties from the abstract [BaseAssetInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_asset_input.htm "The base Analytics asset input."). These base properties appear alongside DataflowInput specific properties in the following table. | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | definition | Object | The dataflow definition. | Required | 50.0 | | historyLabel | String | The history label to tag the saved dataflow version. | Optional | 50.0 | #### See Also - [Dataflow Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm "Returns a dataflow. Reverts a dataflow to a previous version.") # Dataflow Job An Analytics dataflow job. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`dataflow`	AssetReference	The recipe or dataflow run by this dataflow job.	Small, 42.0–45.0	42.0–45.0, Removed in 46.0
`dataflowVersionId`	String	The recipe or dataflow version ID the dataflow job ran against.	Small, 68.0	68.0
`duration`	Integer	The run time, in seconds, of a dataflow job.	Small, 42.0	42.0
`endDate`	Date	The end time of a job’s execution.	Small, 55.0	55.0
`events`	JobEventCollection	The events for this dataflow job.	Small, 60.0	60.0
`executedDate`	Date	The start date and time of a job’s execution.	Small, 46.0	46.0
`inputNodes`	DataflowNodeCollection	The input nodes for this dataflow job.	Small, 55.0	55.0
`jobType`	ConnectJobTypeEnum	The type of job. Valid values are: `DataCloudRecipe` `DataSync` `FileUpload` `Internal` `Orchestrated` `Recipe` `Recipe_V3` `Report` `Restore` `User`	Small, 46.0	46.0
`licenseAttributes`	LicensesAttributes	The Analytics license type and other properties.	Small, 51.0	51.0
`message`	String	The error or informational message of a dataflow job.	Small, 42.0	42.0
`nextRunDate`	Date	The next time to run a job.	Small, 55.0	55.0
`nodesUrl`	String	The URL to the collection of dataflow job nodes.	Small, 50.0	50.0
`outputNodes`	DataflowNodeCollection	The output nodes for this dataflow job.	Small, 55.0	55.0
`progress`	Double	The progress of a job.	Small, 46.0	46.0
`retryCount`	Integer	The number of retries for a job.	Small, 55.0	55.0
`source`	AssetReference	The source of a job.	Small, 46.0	46.0
`startDate`	Date	The start date of the dataflow job.	Small, 42.0	42.0
`status`	ConnectWaveDataflowJobStatusEnum	The runtime status of a dataflow job. Valid values are: `Cancelled` `Failure` `Preprocessing` `Queued` `Running` `Success` `Warning`	Small, 42.0	42.0
`syncDataflows`	DataflowCollection	The dataflows to sync when the job is triggered.	Small, 50.0	50.0
`transformNodes`	DataflowNodeCollection	The transform nodes for this dataflow job.	Small, 57.0	57.0
`waitTime`	Integer	The wait time in seconds before the start of a dataflow job execution.	Small, 53.0	53.0

#### See Also - [Dataflow Jobs List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm "Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes.") - [Dataflow Job Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_id.htm "Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes.") # Dataflow Job Collection A collection of Analytics dataflow jobs. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataflowJobs | [DataflowJob](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job.htm "An Analytics dataflow job.") | A list of dataflow jobs. | Small, 42.0 | 42.0 | | nextPageUrl | String | The URL to get the next page of results. | Small, 51.0 | 51.0 | | url | String | The URL to get the collection. | Small, 42.0 | 42.0 | #### See Also - [Dataflow Jobs List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm "Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes.") # Dataflow Job Input An Analytics dataflow job. Properties

Property Name	Type	Description	Required or Optional	Available Version
`command`	ConnectDataflowJobCommandEnum	Dataflow job command. Valid values are: `Start` `Stop`	Required	42.0
`dataflowId`	ID	The dataflow ID.	Optional; only required when the command is Start	42.0

Property Name	Type	Description	Filter Group and Version	Available Version
`duration`	Integer	The run time in seconds of a node.	Small, 50.0	50.0
`errorLogUrl`	String	The URL to download the error log blob.	Small, 50.0	50.0
`inputRows`	NodeRowCount	The count of input rows to a node.	Small, 50.0	50.0
`message`	String	The error or informational message of a node	Small, 50.0	50.0
`nodeType`	ConnectWaveEltNodeActionEnum	The node type. Valid values are: `Append` `Augment` `BinDigest` `ComputeExpression` `ComputeRelative` `CsvDigest` `Dataset` `DeleteRows` `Delta` `Digest` `Dim2Mea` `Export` `Filter` `Flatten` `IndexDim` `Internal` `Prediction` `RecipeExport` `RecipeTransforms` `Register` `SfdcFetch` `SliceDataset` `SobjectDigest` `Update`	Small, 50.0	50.0
`outputRows`	NodeRowCount	The count of output rows to a node.	Small, 50.0	50.0
`startDate`	Date	The start date of a node.	Small, 50.0	50.0
`status`	ConnectWaveDataflowJobNodeStatusEnum	The run-time status of the node. Valid values are: `Aborted` `Error` `Pending` `Running` `Success` `Warning`	Small, 50.0	50.0

#### See Also - [Dataflow Jobs Node Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes_id.htm "Returns a dataflow job node for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L.") # Dataflow Job Node Collection The collection of nodes for an Analytics dataflow job. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | nodes | [DataflowJobNode](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node.htm "A node in a dataflow job.")\[\] | A list of dataflow job nodes. | Small, 50.0 | 50.0 | | url | String | The URL to get the collection. | Small, 50.0 | 50.0 | #### See Also - [Dataflow Jobs Nodes List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes.htm "Returns a collection of dataflow job nodes for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection.") # Dataflow Job Node Stage A stage in a dataflow job node. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`allParentStageIds`	String[]	A list of all the parent stage IDs.	Small, 66.0	66.0
`createdDate`	Date	The creation date for the stage.	Small, 66.0	66.0
`dataflowJobId`	ID	The ID of the dataflow job.	Small, 66.0	66.0
`durationMillis`	Long	The duration of the stage in milliseconds.	Small, 66.0	66.0
`failureReason`	String	The failure reason if the stage failed.	Small, 66.0	66.0
`id`	ID	The ID of the stage.	Small, 66.0	66.0
`lastModifiedDate`	Date	The last modified date for the stage.	Small, 66.0	66.0
`nodeId`	ID	The ID of the node.	Small, 66.0	66.0
`parentStageIds`	String[]	The list of immediate parent stage Ids.	Small, 66.0	66.0
`recipeNodeApiNames`	String[]	The recipe node API names associated with the stage.	Small, 66.0	66.0
`rowsIn`	Long	The number of input rows processed by the stage.	Small, 66.0	66.0
`rowsOut`	Long	The number of output rows produced by the stage.	Small, 66.0	66.0
`stageId`	String	The Spark engine stage ID.	Small, 66.0	66.0
`stageMetricsJson`	String[]	The full stage metrics as JSON. Only included in a single stage GET	Small, 66.0	66.0
`status`	ConnectWaveDataflowJobNodeStageStatusEnum	The status of the stage. Valid values are: `Failed` `Succeeded`	Small, 50.0	50.0
`url`	String	The URL for the stage.	Small, 66.0	66.0

# Dataflow Job Node Stage Collection The collection of stages for an Analytics dataflow job node. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataflowJobId | ID | The ID of the dataflow job. | Small, 66.0 | 66.0 | | executionPlanId | ID | The ID of the execution plan, where the execution plan is a recipe. | Small, 66.0 | 66.0 | | foundCount | Integer | The number of stages found for the node, only present in batch mode. | Small, 66.0 | 66.0 | | nextPageUrl | String | For pagination, the URL to the next page of stages. Returns null if there aren't more pages. | Small, 66.0 | 66.0 | | nodeId | ID | The ID of the dataflow job node. | Small, 66.0 | 66.0 | | notFoundStageIds | String\[\] | A list of stage Ids that weren't found. Only present in batch mode. Returns an empty list if all Ids are found. | Small, 66.0 | 66.0 | | requestedStageIds | String\[\] | A list of requested stage Ids. Only present in batch mode. | Small, 66.0 | 66.0 | | stages | [DataflowJobNodeStage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_stage.htm "A stage in a dataflow job node.")\[\] | A list of the stages. | Small, 66.0 | 66.0 | | totalStages | Integer | The total number of stages for the node. | Small, 66.0 | 66.0 | | url | String | The URL for this collection of dataflow job node stages. | Small, 66.0 | 66.0 | # Dataflow Job Node Stage Parents The parent information for a dataflow job node stage. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | allParentStageIds | String\[\] | A list of all the parent stage IDs. | Small, 66.0 | 66.0 | | dataflowJobId | ID | The ID of the dataflow job. | Small, 66.0 | 66.0 | | parentStageIds | String\[\] | The list of immediate parent stage Ids. | Small, 66.0 | 66.0 | | stageId | String | The Spark engine stage ID. | Small, 66.0 | 66.0 | # Dataflow Job Node Stage Parents Resource Returns a collection of parents for a dataflow job node stage. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L. ## Resource URL /wave/dataflowjobs//nodes//stages//parents ## Formats JSON ## Available Version 66.0 ## HTTP Methods GET ## Response body for GET [Dataflow Job Node Stage Parents](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_stage_parents.htm "The parent information for a dataflow job node stage.") # Dataflow Job Node Stage Resource Returns a stage for a dataflow job node.This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L. ## Resource URL /wave/dataflowjobs//nodes//stages/ ## Formats JSON ## Available Version 66.0 ## HTTP Methods GET ## Response body for GET [Dataflow Job Node Stage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_stage.htm "A stage in a dataflow job node.") # Dataflow Job Node Stages List Resource Returns a collection of dataflow job node stages for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection. ## Resource URL /wave/dataflowjobs//nodes//stages ## Formats JSON ## Available Version 66.0 ## HTTP Methods GET ## Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`includeMetrics`	ID	Indicates whether to include stage metrics in the response (`true`) or not (`false`)	Optional	66.0
`page Size`	Integer	The number of items to be returned in a single page.	Optional	66.0
`stageIds`	String[]	Filters the collection using a list of stage Ids to return.	Optional	66.0
`status`	ConnectWaveDataflowJobNodeStageStatusEnum	Filters the collection by the stage status. Valid values are: `Failed` `Succeeded`	Optional	66.0

## Response body for GET [Dataflow Job Node Stage Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_stage_collection.htm "The collection of stages for an Analytics dataflow job node.") # Dataflow Job Nodes List Resource Returns a collection of dataflow job nodes for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection. ## Resource URL /wave/dataflowjobs//nodes ## Formats JSON ## Available Version 50.0 ## Available in Postman To view and test a working example of this resource, see [getDataflowJobNodeCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-53e1213e-2e24-403f-b1b0-1b4a09d6c7de?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDataflowJobNodes()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflow-job-nodes.html) ## HTTP Methods GET ## Response body for GET [Dataflow Job Node Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node_collection.htm "The collection of nodes for an Analytics dataflow job.") # Dataflow Job Nodes Resource Returns a dataflow job node for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L. ## Resource URL /wave/dataflowjobs//nodes/ ## Formats JSON ## Available Version 50.0 ## Available in Postman To view and test a working example of this resource, see [getDataflowJobNode](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-b17759f0-5e57-49f5-b6ae-0e8126d85374?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDataflowJobNode()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflow-job-node.html) ## HTTP Methods GET ## Response body for GET [Dataflow Job Node](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node.htm "A node in a dataflow job.") # Dataflow Job Resource Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes. ## Resource URL /wave/dataflowjobs/ ## Formats JSON ## Available Version 42.0 ## Available in Postman To view and test a working example of this resource, see [getDataflowJob](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-9c834bc7-2b8a-4ac4-befe-7c52eb26d9b2?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDataflowJob()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflow-job.html) - LWC — [lightning/analyticsWaveApi updateDataflowJob()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-dataflow-job.html) ## HTTP Methods GET PATCH ## Response body for GET and PATCH [Dataflow Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job.htm "An Analytics dataflow job.") ## Request body for PATCH [Dataflow Job Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataflow_job_input.htm "An Analytics dataflow job.") Use the PATCH API request to stop a Dataflow. To start a Dataflow, use the POST request on /wave/dataflowjobs. The following JSON shows how to stop a dataflowJob. If the dataflowJob ID is 03CS70000004LcDMAU, the resource endpoint is /services/data/v60.0/wave/dataflowJobs/03CS70000004LcDMAU. { "command" : "stop" } ## Start or Stop a Dataflow Job For examples of how to start and stop Dataflow Jobs, see [Start and Stop a Dataflow Job or Recipe](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#start_stop_dataflows) # Dataflow Job Resources Dataflow jobs are used to sync data for data prep recipes and standard dataflows. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Dataflow Jobs List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm "Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes.") | Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes. | GET POST | /wave/dataflowjobs | | [Dataflow Job Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_id.htm "Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes.") | Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes. | GET PATCH | /wave/dataflowjobs/ | | [Dataflow Job Nodes List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes.htm "Returns a collection of dataflow job nodes for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection.") | Returns a collection of dataflow job nodes for a standard dataflow or a recipe. | GET | /wave/dataflowjobs//nodes | | [Dataflow Job Nodes Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes_id.htm "Returns a dataflow job node for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L.") | Returns a dataflow job node for a standard dataflow or a recipe. | GET | /wave/dataflowjobs//nodes | | [Dataflow Job Node Stages List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_stages.htm "Returns a collection of dataflow job node stages for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection.") | Returns a collection of dataflow job node stages for a standard dataflow or a recipe. | GET | /wave/dataflowjobs//nodes//stages | | [Dataflow Job Node Stages Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_stages_id.htm "Returns a stage for a dataflow job node.This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L.") | Returns a stage for a dataflow job node. | GET | /wave/dataflowjobs//nodes//stages/ | | [Dataflow Job Node Stage Parents Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_stages_id_parents.htm "Returns a collection of parents for a dataflow job node stage. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L.") | Returns a collection of parents for a dataflow job node stage. | GET | /wave/dataflowjobs//nodes//stages//parents | ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note For /wave/dataflowjobs//nodes/ endpoints, the requests only work for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L. - **[Dataflow Jobs List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm)** Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes. - **[Dataflow Job Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_id.htm)** Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes. - **[Dataflow Job Nodes List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes.htm)** Returns a collection of dataflow job nodes for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection. - **[Dataflow Job Nodes Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes_id.htm)** Returns a dataflow job node for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L. - **[Dataflow Job Node Stages List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_stages.htm)** Returns a collection of dataflow job node stages for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection. - **[Dataflow Job Node Stage Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_stages_id.htm)** Returns a stage for a dataflow job node.This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L. - **[Dataflow Job Node Stage Parents Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_stages_id_parents.htm)** Returns a collection of parents for a dataflow job node stage. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L. # Dataflow Jobs List Resource Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes. Resource URL /wave/dataflowjobs Formats JSON Available Version 42.0 ## Available in Postman To view and test a working example of this resource, see [getDataflowJobCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-a6762dc7-b8f1-4c1c-8c0e-d51654c4989b?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). Available Components - LWC — [lightning/analyticsWaveApi getDataflowJobs()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_wire_adapters_get_dataflow_jobs) - LWC — [lightning/analyticsWaveApi createDataflowJob()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_analytics_create_dataflow_job) HTTP Methods GET POST Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`dataflowId`	ID	Filters the collection to only contain dataflow jobs tied to this specific dataflow. ID must start with ‘02K’ `/wave/dataflowjobs?dataflowId=02K0000000xxxxx`	Optional	42.0
`jobTypes`	ConnectJobTypeEnum[]	Filters the collection to only contain dataflow jobs for specified job types. Valid values are: `DataCloudRecipe` `DataSync` `FileUpload` `Internal` `Orchestrated` `Recipe` `Recipe_V3` `Report` `Restore` `User` `/wave/dataflowJobs?jobTypes=Recipe,DataSync`	Optional	53.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	Filters the collection by the Analytics license type. Valid values are: `Cdp` (Data 360) `DataPipelineQuery` (Data Pipeline Query) `EinsteinAnalytics` (CRM Analytics) `IntelligentApps` (Intelligent Apps) `Sonic` (Salesforce Data Pipeline)	Optional	53.0
`page`	String	A generated token that indicates the view of dataflow jobs to be returned.	Optional	51.0
`page Size`	Integer	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	51.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	51.0
`startedAfter`	String	Filters the collection to only contain dataflow jobs started at or after the specified date-time (in Epoch seconds in UTC). `/wave/dataflowJobs?startedAfter=1622582667`	Optional	53.0
`startedBefore`	String	Filters the collection to only contain dataflow jobs started at or before the specified date-time (in Epoch seconds in UTC). `/wave/dataflowJobs?startedBefore=1622582667`	Optional	53.0
`status`	ConnectWaveDataflowJobStatusEnum	Filters the collection to only contain dataflow jobs with a specific runtime status. Valid values are: `Failure` `Queued` `Running` `Success` `Warning` `/wave/dataflowJobs?status=Queued`	Optional	51.0

![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If a page or pageSize parameter isn’t provided, the response includes only the dataflow jobs run in the past 7 days. To see jobs older than 7 days, provide a page or pageSize parameter. Response body for GET [Dataflow Job Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_collection.htm "A collection of Analytics dataflow jobs.") Request body for POST Use the POST API request to start a Dataflow. To stop a Dataflow, use the PATCH request on /wave/dataflowjobs/. [Dataflow Job Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataflow_job_input.htm "An Analytics dataflow job.") The following JSON shows how to start a dataflowJob. { "dataflowId": "02KS700000004G3eMAE", "command" : "start" } Response body for POST [Dataflow Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job.htm "An Analytics dataflow job.") Start or Stop a Dataflow Job For examples about how to start and stop Dataflow Jobs, see [Start and Stop a Dataflow Job or Recipe](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#start_stop_dataflows) # Dataflow Node A node in an dataflow job. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`columnCount`	Long	The count of columns.	Small, 55.0	55.0
`endDate`	Date	The end time for the node execution.	Small, 55.0	55.0
`errorMessage`	String	The error message for this dataflow job.	Small, 57.0	57.0
`label`	String	The label of the node source.	Small, 57.0	57.0
`name`	String	The name of the node source.	Small, 55.0	55.0
`outputRowCount`	Long	The count of rows output by the node.	Small, 57.0	57.0
`outputSizeInBytes`	Long	The size of the node output.	Small, 57.0	57.0
`rowCount`	Long	The count of rows.	Small, 55.0	55.0
`sizeInBytes`	Long	The size of the node.	Small, 55.0	55.0
`startDate`	Date	The start time for the node execution.	Small, 55.0	55.0
`status`	ConnectWaveDataflowJobStatusEnum	The status of the job runnsing the node. Valid values are: `Cancelled` `Failure` `Preprocessing` `Queued` `Running` `Success` `Warning`	Small, 57.0	57.0

# Dataflow Node Collection The collection of nodes for an Analytics dataflow. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | nodes | [DataflowNode](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_node.htm "A node in an dataflow job.")\[\] | A list of dataflow nodes. | Small, 55.0 | 55.0 | | totalRowCount | Long | The sum of rows count. | Small, 55.0 | 55.0 | | totalSizeInBytes | Long | The sum of the collection size. | Small, 55.0 | 55.0 | # Dataflow Resource Returns a dataflow. Reverts a dataflow to a previous version. Resource URL /wave/dataflows/ Formats JSON Available Version 37.0 ## Available in Postman To view and test a working example of this resource, see [getDataflow](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-429f4832-5584-479c-a67d-f932a801e14b?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). HTTP Methods GET PATCH (50.0) PUT Run a Dataflow To schedule a dataflow, use the [Dataflow Jobs Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm "Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes.") API. For examples of how to start and stop dataflows, see [Start and Stop a Dataflow Job or Recipe](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#start_stop_dataflows). Schedule a Dataflow To schedule a dataflow, use the [Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm "Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync.") API. For examples of how to schedule dataflows, see [Schedule Dataflows, Recipes, and Data Syncs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#schedule_data_assets). Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | historyId | String | Use the history ID to request a specific dataflow version. | Optional | 42.0 | Response body for GET, PATCH, and PUT [Dataflow](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow.htm "An Analytics dataflow.") Request body for PATCH [Dataflow Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataflow_input.htm "An Analytics dataflow.") Request body for PUT Use the PUT API request to revert to a previous historical version. [Asset Revert History Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_revert_history_input.htm "The Analytics asset history to use for a revert request.") The following JSON shows the revert request for a dataflow version. { "historyId" : "0RmS7000000xxxxxxx" } # Dataflow Resources Dataflows are used to prepare data for Analytics, creating one or more datasets using transformations to manipulate the data. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Dataflow List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows.htm "Returns a collection of dataflows.") | Returns a collection of dataflows | GET | /wave/dataflows | | [Dataflow Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm "Returns a dataflow. Reverts a dataflow to a previous version.") | Returns a dataflow. Reverts a dataflow to a previous version. | GET PATCH PUT | /wave/dataflows/ | - **[Dataflows List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows.htm)** Returns a collection of dataflows. - **[Dataflow Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflows_id.htm)** Returns a dataflow. Reverts a dataflow to a previous version. # Dataflows List Resource Returns a collection of dataflows. ## Resource URL /wave/dataflows ## Formats JSON ## Available Version 37.0 ## Available in Postman To view and test a working example of this resource, see [getDataflowCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-908d9377-62d2-4bdc-b67a-80eb112386bb?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analtyicsWaveApi getDataflows()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataflows.html) ## HTTP Methods GET ## Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | q | String | Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. | Optional | 47.0 | The following REST URL shows how to use the q parameter as a search query in the GET request. /wave/dataflows?q=MyDataflow ## Response body for GET [Dataflow Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_collection.htm "A collection of Analytics dataflows.") # Dataset An Analytics dataset. ## Properties Dataset inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear in Dataset alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`clientShardsUrl`	String	The URL for the dataset shards.	Small, 36.0	36.0
`currentVersionCreatedBy`	WaveUser	The creator of the current version of the dataset. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionCreatedDate`	Date	The time at which the current version of the dataset was created, in ISO8601 date format. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionId`	ID	The 18-character ID of the current dataset version.	Small, 36.0	36.0
`currentVersionLastModifiedBy`	WaveUser	The user who last updated the current version of the dataset. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionLastModifiedDate`	Date	The last time the current version of the dataset was modified, in ISO8601 date format. Only returned if the filterGroup input parameter is set to `Supplemental`.	Supplemental, 36.0	36.0
`currentVersionPredicate`	SecurityPredicate	The security predicate information for the current version of the dataset.	Small, 59.0	59.0
`currentVersionSharingInheritance`	SharingInheritance	The sharing inheritance information for the current version of the dataset.	Small, 59.0	59.0
`currentVersionSupportsNewDates`	Boolean	Indicates whether the current dataset version supports new date formats (`true`) or not (`false`).	Supplemental, 52.0	52.0
`currentVersionTotalRows`	Integer	The total number of rows in the dataset.	Supplemental, 42.0	42.0-52.0
`currentVersionTotalRowCount`	Integer	The total number of rows in the dataset.	Small, 53.0	53.0
`currentVersionUrl`	String	The URL for the current dataset version.	Small, 36.0	36.0
`dataRefreshDate`	Date	The last time this dataset was updated.	Small, 40.0	40.0
`datasetType`	ConnectWaveDatasetTypeEnum	The type of the dataset. Valid values are: `Default` `Live` `StagedData` `Trended`	Small, 41.0	41.0
`folder`	AssetReference	The reference to the folder in which this dataset is stored.	Small, 36.0	36.0
`lastMetadataChangedDate`	Date	The last time the metadata (folder, label, current, sharing, or security predicate) of this dataset was changed.	Small, 51.0	51.0
`lastQueriedDate`	Date	The last time this dataset was queried.	Small, 39.0	39.0
`licenseAttributes`	LicenseAttributes	The Analytics license attributes associated with this dataset.	Small, 52.0	52.0
`liveConnection`	LiveConnection	The live connection details for the dataset.	Small, 50.0	50.0
`userXmd`	Xmd	The associated user XMD.	Medium, 36.0	36.0
`versionsUrl`	String	The URL for dataset versions.	Small, 36.0	36.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the dataset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Small, 51.0	51.0

Property Name	Type	Description	Required or Optional	Available Version
`currentVersionId`	ID	DEPRECATED The 18-character ID of the current version of this dataset.	Optional	36.0–40.0
`datasetType`	ConnectWaveDatasetTypeEnum	The type of the dataset. Valid values are: `Default` `Live` `StagedData` `Trended`	Required	50.0
`folder`	ID	The 18-character ID of the folder that contains the dataset.	Optional	36.0
`liveConnection`	LiveConnectionInput	The live connection details for the dataset.	Optional	50.0
`userXmd`	XmdInput	The user XMD associated with this dataset.	Optional	39.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the dataset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Optional	51.0

#### See Also - [Datasets List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets.htm "Returns a collection of Analytics dataset and creates a dataset.") - [Dataset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataset_id.htm "Returns, deletes, or updates a dataset with the specified ID or API name.") # Dataset Measure Type The measure in a dateset type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). # Dataset Resource Returns, deletes, or updates a dataset with the specified ID or API name. ## Resource URL /wave/datasets/ ## Formats JSON ## Available Version ## Available in Postman To view and test a working example of this resource, see [getDataset](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-76b9e92b-ed58-4a54-b618-c61eea634de4?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). 36.0 ## Available Components - Aura — [ describeDataset()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) - Aura — [ getDatasetFields()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) - LWC — [lightning/analyticsWaveApi getDataset()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataset.html) - LWC — [lightning/analyticsWaveApi createDataset()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-dataset.html) - LWC — [lightning/analyticsWaveApi deleteDataset()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-dataset.html) - LWC — [lightning/analyticsWaveApi updateDataset()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-dataset.html) ## HTTP Methods GET DELETE PATCH ## Response body for GET and PATCH [Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset.htm "An Analytics dataset.") ## Request body for PATCH [Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataset_input.htm "An Analytics dataset.") The following JSON shows how to edit an existing dataset description. { "description": "This is my dataset", "label": "Test Dataset" } # Dataset Resources Manage Analytics dataset and dataset versions. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Datasets List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets.htm "Returns a collection of Analytics dataset and creates a dataset.") | Returns a collection of Analytics datasets and creates a dataset. | GET POST | /wave/datasets | | [Dataset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataset_id.htm "Returns, deletes, or updates a dataset with the specified ID or API name.") | Returns the Analytics dataset with the specified ID, deletes a dataset, or updates a dataset. | GET, DELETE, PATCH | /wave/datasets/ | | [Dataset Versions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm "Returns a list of dataset versions for a particular dataset or creates a version.") | Returns a collection of dataset versions for a particular dataset. | GET | /wave/datasets//versions | | [Dataset Version Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id.htm "Returns an Analytics dataset version or updates the version predicate.") | Returns an Analytics dataset version or updates the predicate. | GET, PATCH | /wave/datasets//versions/ | | [Dataset Version File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id_files_id.htm "Provides access to the binary content of the dataset version file.") | Provides access to the binary content of the dataset file. | GET | /wave/datasets//versions//files/ | - **[Datasets List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets.htm)** Returns a collection of Analytics dataset and creates a dataset. - **[Dataset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataset_id.htm)** Returns, deletes, or updates a dataset with the specified ID or API name. - **[Dataset Versions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm)** Returns a list of dataset versions for a particular dataset or creates a version. - **[Dataset Version Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id.htm)** Returns an Analytics dataset version or updates the version predicate. - **[Dataset Version File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id_files_id.htm)** Provides access to the binary content of the dataset version file. # Dataset Source The source object used to create a dataset. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | object | [ObjectCoverage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_object_coverage.htm "The security coverage for a source object.") | The source object for a dataset. | Small, 41.0 | 41.0 | | securityFields | String\[\] | The dataset fields relevant to security for the object. | Small, 41.0 | 41.0 | # Dataset Type The dateset type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). # Dataset Version A specific version of an Analytics dataset. Properties DatasetVersion inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear in DatasetVersion alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataset | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | A reference to the dataset. | Small, 36.0 | 36.0 | | files | [WaveFileMetadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_file_metadata.htm "The metadata for an Analytics file.")\[\] | The list of information about the data files that make up the dataset version. | Medium, 36.0 | 36.0 | | filesUrl | String | The URL of the files resource for this dataset version. | Small, 36.0 | 36.0 | | predicate | String | The row-level security predicate. Only returned if the predicate is set in the input request. | Small, 36.0 | 36.0 | | predicateVersion | Double | The version of the row-level security predicate. Only returned if the predicate is set in the input request. | Small, 36.0 | 36.0 | | securityCoverageUrl | String | The dataset sharing inheritance coverage information resource. | Small, 41.0 | 41.0 | | sharingSource | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The entity from which sharing rules will be inherited for the dataset version. | Small, 40.0 | 40.0 | | source | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The parent dataflow or file for the dataset version.. | Small, 44.0 | 44.0 | | totalRows | Integer | The total number of rows for the dataset version. | Small, 40.0 | 40.0-52.0 | | totalRowCount | Integer | The total number of rows for the dataset version. | Small, 53.0 | 53.0 | | xmdMain | [Xmd](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd.htm "The extended metadata (Xmd) for an Analytics dataset version.") | The Xmd for this dataset version. | Medium, 36.0 | 36.0 | | xmdsUrl | String | The URL of the Xmd collection resource for this dataset version. | Small, 36.0 | 36.0 | #### See Also - [Dataset Version Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id.htm "Returns an Analytics dataset version or updates the version predicate.") # Dataset Version Collection A collection of versions for an Analytics dataset. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | url | String | The URL to retrieve the collection. | Small, 36.0 | 36.0 | | versions | [DatasetVersion](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version.htm "A specific version of an Analytics dataset.")\[\] | The collection of dataset versions for a particular dataset. | Small, 36.0 | 36.0 | #### See Also - [Dataset Versions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm "Returns a list of dataset versions for a particular dataset or creates a version.") # Dataset Version File Resource Provides access to the binary content of the dataset version file. ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note This resource is accessible only by the Integration User. Resource URL /wave/datasets//versions//files/ Formats JSON Available Version 36.0 HTTP Methods GET GET Response Body Returns the binary content of the dataset file. # Dataset Version Input A specific version of an Analytics dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | isComplete | Boolean | Indicates whether the Dataset Version is complete or not. | Optional | 36.0 | | predicate | String | The row level security predicate to be applied to this Dataset Version. | Optional | 36.0 | | sharingSource | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | Entity from which sharing rules should be inherited. | Optional | 40.0 | | totalRows | Integer | The total number of rows that make up the dataset version. | Optional | 36.0 | #### See Also - [Dataset Version Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm "Returns a list of dataset versions for a particular dataset or creates a version.") # Dataset Version Reference The dataset version the coverage information applies to. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataset | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | A reference to the dataset. | Small, 41.0 | 41.0 | | id | String | The 18 character ID of the dataset version. | Small, 41.0 | 41.0 | | url | String | The asset URL. | Small, 41.0 | 41.0 | # Dataset Version Resource Returns an Analytics dataset version or updates the version predicate. ## Resource URL /wave/datasets//versions/ ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getDatasetVersion](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-99f344f0-5d13-42fb-9854-88851d1af502?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDatasetVersion()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataset-version.html) - LWC — [lightning/analyticsWaveApi updateDatasetVersion()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-dataset-version.html) ## HTTP Methods GET PATCH ## Response body for GET and PATCH [Dataset Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version.htm "A specific version of an Analytics dataset.") ## Request body for PATCH [Dataset Version Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataset_version_input.htm "A specific version of an Analytics dataset.") The following JSON shows how to edit an existing dataset version predicate. { "predicate" : "" } # Dataset Versions List Resource Returns a list of dataset versions for a particular dataset or creates a version. ## Resource URL /wave/datasets//versions ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getDatasetVersionCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-6e4b4e2a-8fc3-4cec-afac-0aa38318451c?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDatasetVersions()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dataset-versions.html) - LWC — [lightning/analyticsWaveApi createDatasetVersion()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-dataset-version.html) ## HTTP Methods GET POST ## GET Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | createdAfter | String | Filters the results to include only dataset versions created after a specific timestamp. | Optional | 62.0 | | createdBefore | String | Filters the results to include only dataset versions created before a specific timestamp. | Optional | 62.0 | | includeArchived | Boolean | Filters the results to include archived dataset versions (true) or not (false). | Optional | 62.0 | ## Response body for GET [Dataset Version Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version_collection.htm "A collection of versions for an Analytics dataset.") ## Request body for POST [Restore Dataset Version Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_restore_dataset_version_input.htm "A specific version to restore an Analytics dataset to.") ## Response body for POST [Restore Dataset Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_restore_dataset_version.htm "The message returned for an Analytics data connector ingest request or an Analytics dataset version update request.") # Datasets List Resource Returns a collection of Analytics dataset and creates a dataset. ## Resource URL /wave/datasets ## Formats JSON ## Available Version GET 36.0 POST 50.0 ## Available in Postman To view and test a working example of this resource, see [getDatasetCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-0850900b-70ff-4536-9b86-11cf3dee9d57?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Aura — [ listDatasets()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) - LWC — [lightning/analyticsWaveApi getDatasets()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-datasets.html) ## HTTP Methods GET POST ## GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`createdAfter`	String	Filters the results to include only the contents created after a specific timestamp.	Optional	56.0
`createdBefore`	String	Filters the results to include only the contents created before a specific timestamp.	Optional	56.0
`datasetTypes`	ConnectWaveDatasetTypeEnum	The type of the dataset. Valid values are: `Default` `Live` `StagedData` `Trended`	Optional	50.0
`folderId`	ID	Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder.	Optional	36.0
`hasCurrentOnly`	Boolean	Indicates whether to filter the list of datasets to include only those datasets that have a current version (`true`) or not (`false`). The default is `false`.	Optional	52.0
`ids`	ID[]	Filter the list of datasets to include only datasets with the specified ids.	Optional	53.0
`includeCurrentVersion`	Boolean	Indicates whether to include the current dataset version metadata in the collection (`true`) or not (`false`). The default is `false`.	Optional	52.0
`lastQueriedAfter`	String	Filters the results to include only the contents last queried after a specific timestamp.	Optional	56.0
`lastQueriedBefore`	String	Filters the results to include only the contents last queried before a specific timestamp.	Optional	56.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	Filters the collection by the Analytics license type. Valid values are: `Cdp` (Data 360) `DataPipelineQuery` (Data Pipeline Query) `EinsteinAnalytics` (CRM Analytics) `IntelligentApps` (Intelligent Apps) `Sonic` (Salesforce Data Pipeline)	Optional	52.0
`order`	Enum	Ordering applied to the results. Valid values are: `Ascending` `Descending`	Optional	42.0
`page`	String	A generated token that indicates the view of datasets to be returned.	Optional	36.0
`pageSize`	Int	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	36.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	36.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `Browse` `CreatedByMe` `InsightsApplicationsIsCansEdit` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`sort`	ConnectWaveDatasetSortOrderTypeEnum	The type of sort order to be applied to the returned dataset collection. Valid values are: `ConnectionName` (only valid if the dataset is a Live Dataset) `CreatedBy` `CreatedDate` `LastArchivedBy` `LastArchivedDate` `LastModified` `LastQueried` `LastRefreshed` `Mru` (Most Recently Used, last viewed date) `Name` `TotalRows`	Optional	38.0
`supportsNewDates`	Boolean	Indicates whether to filter the list of datasets to include only those datasets that support new dates (`true`) or not (`false`). The default is `false`.	Optional	52.0
`typeOfDataflow`	String	Filters the list of datasets to include only those datasets that have the specified type of dataflow.	Optional	61.0

You can filter the results to include only those datasets that have a current dataset version defined by using the hasCurrentOnly parameter. You can also request supplemental information about datasets that have a current dataset version defined by using the filterGroup 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_returns_filters.htm) in the Connect REST API Developer Guide. ## Response body for GET [Dataset Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_collection.htm "A collection of datasets.") ## Request body for POST [Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dataset_input.htm "An Analytics dataset.") ## Response body for POST [Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset.htm "An Analytics dataset.") # Date Time Type The date time type of an Analytics template variable. ## Properties Inherits properties from [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable."). # Dependencies Resource Returns the dependencies for an asset. The dependencies resource returns only assets on which you have view access. ## Resource URL /wave/dependencies/ ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getDependency](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-2da5fcbd-8a02-4169-9fce-30f72677624f?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getDependencies()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-dependencies.html) ## HTTP Methods GET ## Response body for GET [Dependency](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dependency.htm "An Analytics asset dependency.") # Dependency An Analytics asset dependency. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`assetSharingUrl`	String	The sharing URL for an asset.	Small, 36.0	36.0
`components`	DependencyCollection	The components that depend on the asset.	Small, 46.0	46.0
`dashboards`	DependencyCollection	The dashboards that depend on the asset.	Small, 36.0	36.0
`datasets`	DependencyCollection	The datasets that depend on the asset.	Small, 36.0	36.0
`folder`	AssetReference	The folder containing the asset.	Small, 36.0	36.0
`id`	String	The 18-character asset ID.	Small, 36.0	36.0
`isArchived`	Boolean	Indicates whether the asset is archived (`true`) or not (`false`).	Small, 67.0	67.0
`lastAccessedDate`	Date	The time at which the asset was last accessed.	Small, 36.0	39.0
`lastModifiedBy`	WaveUser	The user who last modified the asset.	Small, 36.0	36.0
`lastModifiedDate`	Date	The last time the asset was modified, in ISO8601 date format.	Small, 36.0	36.0
`lenses`	DependencyCollection	The lenses that depend on the asset.	Small, 36.0	36.0
`name`	String	The name of the asset.	Small, 36.0	36.0
`recipes`	DependencyCollection	The recipes that depend on the asset.	Small, 44.0	44.0
`type`	ConnectWaveAssetTypeEnum	The asset type. Valid values are `Collection` `Component` `ContextualDashboard` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataCloudReport` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `TableauDashboard` `TableauWorkbook` `Template` `Widget` `Workflow`	Small, 36.0	36.0
`url`	String	The URL to retrieve the definition of the asset.	Small, 36.0	36.0
`workflows`	DependencyCollection	The dataflows that depend on the asset.	Small, 36.0	36.0

#### See Also - [Dependencies Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dependencies_id.htm "Returns the dependencies for an asset.") # Dependency Collection A collection of Analytics asset dependencies. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dependencies | [Dependency](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dependency.htm "An Analytics asset dependency.")\[\] | The list of dependencies for an asset. | Small, 36.0 | 36.0 | | totalreSize | Integer | The total count of the dependencies. | Small, 36.0 | 36.0 | # Directory Item Collection A collection of directory items. JSON example { "auto-install-requests" : "/services/data/v54.0/wave/auto-install-requests", "dashboards" : "/services/data/v54.0/wave/dashboards", "dataConnectorTypes" : "/services/data/v54.0/wave/dataConnectorTypes", "dataConnectors" : "/services/data/v54.0/wave/dataConnectors", "dataflowjobs" : "/services/data/v54.0/wave/dataflowjobs", "datasets" : "/services/data/v54.0/wave/datasets", "folders" : "/services/data/v54.0/wave/folders", "limits" : "/services/data/v54.0/wave/limits", "lenses" : "/services/data/v54.0/wave/lenses", "query" : "/services/data/v54.0/wave/query", "recipes" : "/services/data/v54.0/wave/recipes", "replicatedDatasets" : "/services/data/v54.0/wave/replicatedDatasets", "schedules" : "/services/data/v54.0/wave/watchlist/schedules", "templates" : "/services/data/v54.0/wave/templates", "trendedreports" : "/services/data/v54.0/wave/trendedreports" } Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | auto-install-requests | String | URL of the auto-install requests resource for the organization. | Small, 50.0 | 50.0 | | dashboards | String | URL of the dashboards resource for the organization. | Small, 36.0 | 36.0 | | dataConnectorTypes | String | URL of the dataConnectorTypes resource for the organization. | Small, 39.0 | 39.0 | | dataConnectors | String | URL of the dataConnectors resource for the organization. | Small, 39.0 | 39.0 | | dataflowjobs | String | URL of the dataflowjobs resource for the organization. | Small, 42.0 | 42.0 | | datasets | String | URL of the datasets resource for the organization. | Small, 36.0 | 36.0 | | folders | String | URL of the folders resource for the organization. | Small, 36.0 | 36.0 | | limits | String | URL of the limits resource for the organization | Small, 51.0 | 51.0 | | lenses | String | URL of the lenses resource for the organization. | Small, 36.0 | 36.0 | | query | String | URL of the query resource for the organization. | Small, 36.0 | 36.0 | | recipes | String | URL of the recipes resource for the organization. | Small, 38.0 | 38.0 | | replicatedDatasets | String | URL of the replicatedDatasets resource for the organization. | Small, 37.0 | 37.0 | | schedules | String | URL of the watchlist schedules resource for the organization. | Small, 48.0 | 48.0 | | templates | String | URL of the templates resource for the organization. | Small, 36.0 | 36.0 | | trendedreports | String | URL of the trendedreports resource for the organization. | Small, 37.0 | 37.0 | #### See Also - [Wave Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_wave.htm "Lists the top-level resources available for Analytics.") # Display Message The display message for an Analytics template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | location | String | The name of the page where the text is to be displayed. | Small, 36.0 | 36.0 | | text | String | The text content to display. | Small, 36.0 | 36.0 | # Eclair Chart Resources Eclair charts render maps and geodata in Analytics dashboards. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Charts Maps List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps.htm "Returns a list of maps or creates a map.") | Returns a collection of maps, or creates a map. | GET POST | /eclair/maps | | [Charts Maps Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps_id.htm "Returns, updates, or deletes a specific map.") | Get, update, or delete a specific map. | DELETE GET PATCH | /eclair/maps/ | | [Charts Geodata Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id.htm "Returns a geodata definition, updates, or delete a geodata definition.") | Get, update, or delete a specific geodata definition. | DELETE GET PATCH | /eclair/geodata/ | | [Charts Geodata List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata.htm "Returns a collection of geodata definitions and creates a geodata definition.") | Returns a collection of geodata definitions, or creates a geodata definition. | GET POST | /eclair/geodata | | [Charts Geodata File List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id_file.htm "Return the binary file associated with a geodata definition.") | Get the binary file associated with a geodata definition. | GET | /eclair/geodata//file | - **[Charts Geodata List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata.htm)** Returns a collection of geodata definitions and creates a geodata definition. - **[Charts Geodata Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id.htm)** Returns a geodata definition, updates, or delete a geodata definition. - **[Charts Geodata File List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id_file.htm)** Return the binary file associated with a geodata definition. - **[Charts Maps List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps.htm)** Returns a list of maps or creates a map. - **[Charts Maps Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps_id.htm)** Returns, updates, or deletes a specific map. # Empty Schedule Specify an empty schedule for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.") # Event Based Schedule Input Specify an event-driven schedule for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset.") | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | triggerRule | String | The expression defining the events that trigger the schedule of the target asset. Currently accepts scheduling of Dataflows and Recipes as the target. | Required | 53.0 | # Event Driven Schedule Specify an event-driven schedule for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.") | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | triggerRule | String | The expression defining the events that trigger the schedule of the target asset. | Small, 52.0 | 52.0 | # Featured Assets The featured assets. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | assets | [TypedAssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_typed_asset_reference.htm "A typed Analytics asset reference.")\[\] | The list of featured assets. | Small, 39.0 | 39.0 | # Featured Assets Input A feaatured assets for an Analytics app. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assets | [TypedAssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_typed_asset_reference_input.htm "A typed Analytics asset reference.")\[\] | The list of default featured assets | Required | 39.0 | # Features Configuration Resource The Analytics features that are available to a user. Resource URL /wave/config/features Formats JSON Available Version 36.0 HTTP Methods GET Response body for GET [Wave Features](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_features.htm "The Analytics features enabled for a user.") # Folder Resource Returns, deletes, updates, or replaces an Analytics app or folder with the specified ID. ## Resource URL /wave/folders/ ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getWaveFolder](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-0f3fa4c6-4537-46d7-b5c1-549cd3abece9?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Aura — [ updateFolder()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - Aura — [ upgradeFolder()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - Aura — [ deleteFolder()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - LWC — [lightning/analyticsWaveApi getWaveFolder()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-folder.html) - LWC — [lightning/analyticsWaveApi deleteWaveFolder()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-wave-folder.html) - LWC — [lightning/analyticsWaveApi updatePartialWaveFolder()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-partial-wave-folder.html) - LWC — [lightning/analyticsWaveApi updateWaveFolder()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-wave-folder.html) ## HTTP Methods GET DELETE PATCH PUT ## GET Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | disableMru | Boolean | Indicates whether to update the MRU should be updated (true) or not (false). | Optional | 53.0 | | mobileOnlyFeaturedAssets | Boolean | Indicates whether to filter the collection of folders to show only dashboards that are enabled for the Analytics mobile app (true) or not (false) . | Optional | 43.0 | To get the application log for the folder, use the filterGroup request parameter with the Supplemental value in the GET request. /wave/folders/?filterGroup=Supplemental ## Response body for GET [Wave Folder](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder.htm "An Analytics folder.") ## Request body for PUT and PATCH This can be a [Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_input.htm "An Analytics folder. This implements BaseWaveFolderInput.") or a [Wave Folder Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_template_input.htm "A templated Analytics folder. This implements BaseWaveFolderInput."), both of which implement the [Base Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_wave_folder_input.htm "The base Analytics folder asset."). ## Response body for PATCH and PUT [Wave Folder](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder.htm "An Analytics folder.") # Folder Resources Analytics folders represent apps, a collection of assets. Folders can be created by users or by Analytics templates. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Folders List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm "Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.") | Returns a collection of apps or folders and creates an Analytics app | GET POST | /wave/folders | | [Folder Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm "Returns, deletes, updates, or replaces an Analytics app or folder with the specified ID.") | Returns a folder, updates a folder, or deletes a folder. | GET PATCH DELETE | /wave/folders/ | | [Folder Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_schedule.htm "Returns, deletes, or updates the schedule for an Analytics app or folder with the specified ID.") | Returns a folder schedule, updates a folder schedule, or deletes a folder schedule. | GET PATCH DELETE | /wave/folders//schedule | | [Folder Settings Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_settings.htm "Returns or updates the settings for an Analytics app or folder with the specified ID.") | Returns folder settings or updates folder settings. | GET PUT | /wave/folders//settings | - **[Folders List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm)** Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard. - **[Folder Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm)** Returns, deletes, updates, or replaces an Analytics app or folder with the specified ID. - **[Folder Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_schedule.htm)** Returns, deletes, or updates the schedule for an Analytics app or folder with the specified ID. - **[Folder Settings Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_settings.htm)** Returns or updates the settings for an Analytics app or folder with the specified ID. # Folder Schedule Resource Returns, deletes, or updates the schedule for an Analytics app or folder with the specified ID. Resource URL /wave/folders//schedule Formats JSON Available Version 57.0 HTTP Methods GET DELETE PATCH Response body for GET and PATCH [Wave Folder Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder_schedule.htm "An Analytics folder schedule.") Request body for PATCH [Wave Folder Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_schedule_input.htm "An Analytics folder schedule.") # Folder Settings Resource Returns or updates the settings for an Analytics app or folder with the specified ID. Resource URL /wave/folders//settings Formats JSON Available Version 57.0 HTTP Methods GET PUT Response body for GET and PUT [Analytics App Setting Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_analytics_app_setting_collection.htm "The collection of Analytics app settings.") Request body for PUT [Analytics App Setting Collection Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_analytics_app_setting_collection_input.htm "The collection of Analytics app settings.") # Folders List Resource Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard. ## Resource URL /wave/folders ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getWaveFolderCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-1ef07cc4-fcb6-47f4-9bee-0262bfe41533?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Aura — [ createFolder()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - Aura — [ listFolders()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - LWC — [lightning/analyticsWaveApi getWaveFolders()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-folders.html) - LWC — [lightning/analyticsWaveApi postWaveFolders()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-post-wave-folders.html) ## HTTP Methods GET POST ## Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`isPinned`	Boolean	Indicates whether to filter the collection of folders to return only pinned folders (`true`) or not (`false`).	Optional	36.0
`mobileOnlyFeaturedAssets`	Boolean	Indicates whether to filter the collection of folders to show only dashboards that are enabled for the Analytics mobile app (`true`) or not (`false`).	Optional	43.0
`page`	String	A generated token that indicates the view of folders to be returned.	Optional	36.0
`pageSize`	Integer	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	36.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	36.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `Browse` `CreatedByMe` `InsightsApplicationsIsCansEdit` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `App` `CreatedBy` `CreatedById` `CreatedDate` `FolderName` `LastModified` `LastModifiedBy` `LastModifiedById` `LastModifiedDate` `Location` `Mru` (Most Recently Used, last viewed date) `Name` `Outcome` `Owner` `RefreshDate` (for assets like datasets) `RunDate` (for assets like reports) `Status` `Title` `Type`	Optional	38.0
`templateFilters`	ConnectWaveTemplateSearchFiltersEnum	The filter templates to apply to the returned collection. Valid values are: `AppsConstructedByTemplate` `AppsWithInstallHistory`	Optional	57.0
`templateSourceId`	String	Filters the results to include only a collection of folders created from a specific template source	Optional	36.0

## Response body for GET [Wave Folder Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder_collection.htm "A collection of Analytics folders.") ## Request body for POST This is a [Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_input.htm "An Analytics folder. This implements BaseWaveFolderInput.") or a [Wave Folder Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_template_input.htm "A templated Analytics folder. This implements BaseWaveFolderInput."), both of which implement the [Base Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_wave_folder_input.htm "The base Analytics folder asset."). ## Response body for POST [Wave Folder](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_folder.htm "An Analytics folder.") # Geo Data The geo data used by a map. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	String	The ID of the geodata record.	Small, 38.0	38.0
`label`	String	The geodata label.	Small, 38.0	38.0
`name`	String	The geodata developer name.	Small, 38.0	38.0
`namespace`	String	The namespace that qualifies the geodata.	Small, 39.0	39.0
`type`	ConnectEclairGeoDataTypeEnum	The type of geodata. Valid values are: `GeoJSON`	Small, 38.0	38.0
`url`	String	The url to retrieve the geodata.	Small, 38.0	38.0

#### See Also - [Charts Geodata List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata.htm "Returns a collection of geodata definitions and creates a geodata definition.") - [Charts Geodata Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id.htm "Returns a geodata definition, updates, or delete a geodata definition.") # Geo Data Collection A collection of the geo data used by a map. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | geoData | [GeoData](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_geo_data.htm "The geo data used by a map.")\[\] | A list of the geodata. | Small, 38.0 | 38.0 | #### See Also - [Charts Geodata List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata.htm "Returns a collection of geodata definitions and creates a geodata definition.") # Geo Data Input The geo data used by a map. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | label | String | The geodata label. | Optional | 39.0 | | name | String | The geodata developer name. | Optional | 39.0 | #### See Also - [Charts Geodata List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata.htm "Returns a collection of geodata definitions and creates a geodata definition.") - [Charts Geodata Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_geodata_id.htm "Returns a geodata definition, updates, or delete a geodata definition.") # Group Box Item A group box item on a panel for an Analytics template wizard page. ## Properties Inherits properties from [Panel Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm "An item on a panel in a column layout for an Analytics template wizard page."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | description | String | The description for the group. | Small, 59.0 | 59.0 | | item | [PanelItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm "An item on a panel in a column layout for an Analytics template wizard page.")\[\] | A list of items in the group. | Small, 59.0 | 59.0 | | title | String | The title for the group. | Small, 59.0 | 59.0 | # Guidance Panel The guidance panel for a template configuration wizard page. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | backgroundImage | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The optional background image for the guidance panel on a template wizard page. | Small, 59.0 | 59.0 | | items | [PanelItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm "An item on a panel in a column layout for an Analytics template wizard page.")\[\] | A list of items to display for the guidance page on a template wizard page. | Small, 59.0 | 59.0 | | title | String | The title for the guidance panel on a template wizard page. | Small, 59.0 | 59.0 | # Header The header for an Analytics template wizard page. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | description | String | The detail description for the page. | Small, 56.0 | 56.0 | | text | String | The title for the header. | Small, 56.0 | 56.0 | # Hourly Schedule Specify an hourly schedule for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.")

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 40.0	40.0
`hourlyInterval`	Integer	Number of hours in between queuing or scheduling of an asset.	Small, 40.0	40.0
`lastHour`	Integer	Hour of day at which the schedule stops queuing the asset for processing.	Small, 40.0	40.0

# Hourly Schedule Input Specify a sub-daily schedule for an Analytics asset. Properties Inherits notification, and time from [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset.")

Property Name	Type	Description	Required or Optional	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Required	39.0
`hourlyInterval`	Integer	Number of hours in between queuing or scheduling of an asset.	Required	39.0
`lastHour`	Integer	Hour of day at which the schedule stops queuing the asset for processing.	Required	39.0

# Image Asset Reference A image asset for Analytics. Properties ImageAssetReference inherits properties from the abstract [BaseAssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_asset_reference.htm "The base Analytics asset."). These base properties appear in ImageAssetReference alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | description | String | The image description. | Small, 44.0 | 44.0 | # Image Item An image item on a panel for an Analytics template wizard page. ## Properties Inherits properties from [Panel Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm "An item on a panel in a column layout for an Analytics template wizard page."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | image | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The asset reference for the image. | Small, 56.0 | 56.0 | # Job Event An audit events for a job, like recipe start or dataflow cancelled. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`createdBy`	WaveUser	The user that created the event.	Small, 60.0	60.0
`createdDate`	Date	The date and time an event was created.	Small, 60.0	60.0
`eventType`	DataPlatformAuditTypeEnum	The type of of audit event. Valid values are: `JobCancelled` (Job was canceled by a user) `JobRunEventBased` (Job was run on an event-based schedule) `JobRunManual` (Job was run manually) `JobRunTimeBased` (Job was run on an time-based schedule) `JobScheduleModified` (Job schedule was modified) `JobScheduled` (Job was scheduled) `JobUnscheduled` (Job was unscheduled)	Small, 60.0	60.0

# Job Event Collection A collection of audit events for jobs, like recipe start or dataflow cancelled. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | events | [JobEvent](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_job_event.htm "An audit events for a job, like recipe start or dataflow cancelled.")\[\] | The list of audit events for a job. | Small, 60.0 | 60.0 | # Json Transformation The transformed JSON after processing the transformation rules. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | document | Map | The arbitrary JSON document result after the constants, rules, and macros have been applied. | Small, v43.0 | 43.0 | #### See Also - [JsonXform Transformation Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_jsonxform_transformation.htm "Performs a JSON transformation by invoking a set of rules and expressions on a JSON document. The transformed JSON is returned in the REST response and isn't saved on the server. This service is provided to test rules used in Analytics templates.") # Json Transformation Input The JSON request to perform transformation rules on. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | definition | [RuleDefinitionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_rule_definition_input.htm "A rule definition to use for a JSON transformation.") | The definition of constants, macros, and rules to apply to the provided document parameter. | Required | 43.0 | | document | Map | The arbitrary JSON document to run the rules from the definition parameter against. | Required | 43.0 | | values | Map | A map of value objects used to resolve variables in the definition parameter expressions | Required | 43.0 | #### See Also - [JsonXform Transformation Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_jsonxform_transformation.htm "Performs a JSON transformation by invoking a set of rules and expressions on a JSON document. The transformed JSON is returned in the REST response and isn't saved on the server. This service is provided to test rules used in Analytics templates.") # JsonXform Transformation Resource Performs a JSON transformation by invoking a set of rules and expressions on a JSON document. The transformed JSON is returned in the REST response and isn't saved on the server. This service is provided to test rules used in Analytics templates. ## Resource URL /wave/jsonxform/transformation ## Formats JSON ## Available Version 43.0 ## HTTP Methods POST ## Request body for POST [Json Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_json_transformation_input.htm "The JSON request to perform transformation rules on.") ## Response body for POST [Json Transformation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_json_transformation.htm "The transformed JSON after processing the transformation rules.") For more information about testing JSON transformations, see [Rules Testing with jsonxform/transformation endpoint](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_wave_templates.meta/bi_dev_guide_wave_templates/bi_templatesdev_jsonxform_transformation.htm) in the Analytics Templates Developer Guide. # Layout The base layout for an Analytics template wizard page. ## Properties Inherited by [CustomComponentLayout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_custom_component_layout.htm "A custom component layout for an Analytics template wizard page."), [SingleColumnLayout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_single_column_layout.htm "A single column layout for an Analytics template wizard page.") and [TwoColumnLayout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_two_column_layout.htm "A two column layout for an Analytics template wizard page.")

Property Name	Type	Description	Filter Group and Version	Available Version
`header`	Header	The header information for the page.	Small, 56.0	56.0
`type`	LayoutTypeEnum	The layout type. Valid values are: `Component` `SingleColumn` `TwoColumn`	Optional	52.0

# Lens Am Analytics lenses. ## Properties Lens inherits properties from the abstract [Base Templated Asset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_templated_asset.htm "A base Analytics asset created from a template."). These base properties appear in Lens alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`allowPreview`	Boolean	Indicates whether the user is allowed to preview the lens.	Small, 36.0	36.0
`dataset`	AssetReference	DEPRECATED A reference to the dataset used to create this lens.	Small, 36.0	36.0-42.0
`datasets`	AssetReference[]	A list of the datasets that the lens uses.	Small, 43.0	43.0
`dateVersion`	Integer	The version of dates used by the lens. Valid values are: `1` `2`	Small, 44.0	44.0
`files`	LensFile[]	The list of the lens files.	Medium, 36.0	36.0
`filesUrl`	String	The URL to the lens files.	Small, 36.0	36.0
`folder`	AssetReference	A reference to the folder in which this lens is stored.	Small, 36.0	36.0
`historiesUrl`	String	The URL for the lens histories associated with this lens.	Small, 44.0	44.0
`refreshDate`	Date	The date of the most recent current dataset that is used by the lens, in ISO8601 date format.	Small, 36.0	36.0
`state`	LensState	The state of the lens.	Big, 36.0	36.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Small, 51.0	51.0
`visualizationType`	String	The visualization type used for this lens. Valid values are: Valid values are: `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gantt` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	Small, 36.0	36.0

Parameter Name

Type

Description

Required or Optional

Available Version

lensIdOrApiName

The lens ID or API name to request the files for.

Required

36.0

page

String

A generated token that indicates the view of the lenses to be returned.

Optional

36.0

pageSize

Integer

The number of items to be returned in a single page. Minimum is 1,

maximum is 200, and default is 25.

Optional

36.0

## GET Response Body [Wave File Metadata Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_file_metadata_collection.htm "A collection of the metadata for Analytics files.") ## POST Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | lensIdOrApiName | ID | The lens ID or API name to upload the file to. | Required | 36.0 | ## POST Request Body The binary upload to create the preview file. ## POST Response Body [Wave File Metadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_file_metadata.htm "The metadata for an Analytics file.") # Lens File Resource Returns or updates a file that is part of an Analytics lens. ## Resource URL /wave/lenses//files/ ## Formats JSON ## Available Version 36.0 ## HTTP Methods GET PUT ## GET and PUT Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fileId | Id | The 18 character file ID to return. | Required | 36.0 | | lensIdOrApiName | ID | The lens ID or API name to request the files for. | Required | 36.0 | ## GET Response Body Returns the binary stream of the contents of the specified file. ## PUT Request Body The binary upload to update the preview file with. ## PUT Response Body [Wave File Metadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_file_metadata.htm "The metadata for an Analytics file.") # Lens Input An Analytics lens. ## Properties Lens Input inherits properties from the abstract [Base Asset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_asset_reference_input.htm "The base Analytics asset."). These base properties appear in Lens Input alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`datasets`	AssetReferenceInput[]	The list of datasets used to create this lens.	Required for POST, optional for PATCH	43.0
`folder`	AssetReferenceInput	The folder in which this lens is stored.	Required for POST, optional for PATCH	36.0
`historylabel`	String	The history label of the lens version being saved.	Optional	46.0
`state`	LensStateInput	The state of the lens.	Required for POST, optional for PATCH	36.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Optional	51.0
`visualizationType`	ConnectWaveVisualizationTypeEnum	The visualization type of the lens. Valid values are: `Bullet` `CalendarHeatMap` `Combo` `ComparisonTable` `Flatgauge` `Gantt` `Gauge` `HeatMap` `HorizontalBar` `HorizontalDot` `Line` `Matrix` `ParallelCoordinates` `Pie` `PivotTable` `Polargauge` `Pyramid` `Rating` `Scatter` `StackWaterfall` `StackedHorizontalBar` `StackedVerticalBar` `Time` `TimeBar` `TimeCombo` `ValuesTable` `VerticalBar` `VerticalDot` `Waterfall`	Required for POST, optional for PATCH	36.0
`xmd`	XmdInput	The asset XMD of the lens.	Optional	43.0

#### See Also - [Lenses List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses.htm "Returns a list of Analytics lenses or creates a lens.") - [Lens Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm "Returns, deletes, or updates the lens with the specified ID or API name.") # Lens Resource Returns, deletes, or updates the lens with the specified ID or API name. ## Resource URL /wave/lenses/ ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getLens](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-dd502784-37ea-4d53-a297-c5af5d933169?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Apex — [Wave.Lenses.getLens()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_apex_query.htm) - Aura — [ describeLens()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods GET DELETE PATCH ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If the specified lens is archived (moved to the Recycle Bin), a GET request returns a 404 Not Found error. ## GET and PATCH Request Parameters | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | lensIdOrApiName | ID | The lens ID or API name to return or update. | Required | 36.0 | ## GET and PATCH Response Body [Lens](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens.htm "Am Analytics lenses.") ## PATCH Request Body [Lens Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_lens_input.htm "An Analytics lens.") # Lens Resources Analytics lenses are how users view data in a dataset and are the basis for building any dashboard. These resources allow users to manage collections of lenses, individual lenses, and lens files. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Lenses List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses.htm "Returns a list of Analytics lenses or creates a lens.") | Returns a collection of Analytics lenses, or creates a lens. | GET POST | /wave/lenses | | [Lens Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm "Returns, deletes, or updates the lens with the specified ID or API name.") | Returns a JSON file that describes the structure of an Analytics lens with the specified ID, deletes a lens, or updates a lens. | GET DELETE PATCH | /wave/lenses/ | | [Lens Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_bundle.htm "Returns or updates the lens bundle with the specified ID or API name.") | Returns a JSON file that describes the structure of an Analytics lens bundle with the specified ID or updates a lens bundle. | GET PUT | /wave/lenses//bundle | | [Lens File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_files_id.htm "Returns or updates a file that is part of an Analytics lens.") | Returns a file that is part of an Analytics lens. | GET PUT | /wave/lenses//files/ | - **[Lenses List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses.htm)** Returns a list of Analytics lenses or creates a lens. - **[Lens Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id.htm)** Returns, deletes, or updates the lens with the specified ID or API name. - **[Lens File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_files_id.htm)** Returns or updates a file that is part of an Analytics lens. - **[Lens File Metadata Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_files.htm)** Returns or creates the lens file metadata with the specified ID or API name. - **[Lens Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_bundle.htm)** Returns or updates the lens bundle with the specified ID or API name. # Lens Source Asset A contextual representation of an Analytics lens. ## Properties LensSourceAsset inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dashboardId | ID | The 18-character id of a dashboard. | Small, 58.0 | 58.0 | | savedView | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The saved view of a dashboard. | Small, 58.0 | 58.0 | # Lens State The state for an Analytics lenses. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`options`	LensVisualization Option	The configuration options for different lens visualizations. Valid values are: BarLensVisualizationOptions ComparisonTableLensVisualizationOptions DotLensVisualizationOptions HeatMapLensVisualizationOptions MatrixLensVisualizationOptions ParallelCoordsLensVisualizationOptions PieLensVisualizationOptions PivotTableLensVisualizationOptions ScatterLensVisualizationOptions StackedBarLensVisualizationOptions TableLensVisualizationOptions TimeLensVisualizationOptions ValuesTableLensVisualizationOptions	Small, 36.0	36.0
`query`	Query	The SAQL query used to create this lens.	Small, 36.0	36.0

## BarLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 | | miniBars | Integer | The width of the mini-bars, if used. | Small, 36.0 | 36.0 | | multiMetrics | Boolean | Indicates whether multiple measures are projected on the same chart, side by side, or if every measure is in its own chart. | Small, 36.0 | 36.0 | | splitAxis | Boolean | Indicates whether each measure is projected on one axis or if all measures share an axis. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | | trellis | Boolean | Indicates whether the last group is treated as a trellis dimension or not. Every distinct value of the dimension is a chart. | Small, 36.0 | 36.0 | ## ComparisonTableLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | maxColumnWidth | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 | | subtotals | Boolean | Indicates whether to display subtotals in the table or not. | Small, 48.0 | 48.0 | | totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 | ## DotLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fit | Boolean | Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. | Small, 36.0 | 36.0 | | legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## HeatMapLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## MatrixLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## ParallelCoordsLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fit | Boolean | Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. | Small, 36.0 | 36.0 | | legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## PieLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## PivotTableLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | columnTotals | Boolean | Indicates whether to display column totals in the table (true) or not (false). | Small, 55.0 | 55.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 | | rowTotals | Boolean | Indicates whether to display row totals in the table (true) or not (false). | Small, 55.0 | 55.0 | | totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 | ## ScatterLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fit | Boolean | Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. | Small, 36.0 | 36.0 | | legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## StackedBarLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 | | miniBars | Integer | The width of the mini-bars, if used. | Small, 36.0 | 36.0 | | normalize | Boolean | Indicates whether to scale the position and size of data shape so that it’s proportional to its percentage of its category or not. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## TableLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | columnTotals | Boolean | Indicates whether to display column totals in the table (true) or not (false). | Small, 55.0 | 55.0 | | subtotals | Boolean | Indicates whether to display subtotals in the table or not. | Small, 48.0 | 48.0 | | rowTotals | Boolean | Indicates whether to display row totals in the table (true) or not (false). | Small, 55.0 | 55.0 | | totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 | ## TimeLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | legend | Boolean | Indicates whether to display the legend or not. | Small, 36.0 | 36.0 | | legendHideHeader | Boolean | Indicates whether to hide the legend header or not. | Small, 36.0 | 36.0 | | legendWidth | Integer | The width of the legend. | Small, 36.0 | 36.0 | | multiMetrics | Boolean | Indicates whether multiple measures are projected on the same chart, side by side, or if every measure is in its own chart. | Small, 36.0 | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale or not. | Small, 36.0 | 36.0 | ## ValuesTableLensVisualizationOptions | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | hideHeaderColumn | Boolean | Indicates whether to display header column or not. | Small, 36.0 | 36.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Small, 36.0 | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Small, 36.0 | 36.0 | | totals | Boolean | Indicates whether to display totals in the table or not. | Small, 36.0 | 36.0 | ## Query | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | aggregateFilters | Object | The query aggregate filters. | Small, 48.0 | 48.0 | | limit | Object | The query limit. | Small, 48.0 | 48.0 | | orders | Object | The query orders. | Small, 48.0 | 48.0 | | pivotTotals | String | The query pivot totals. | Small, 55.0 | 55.0 | | query | String | The SAQL query text. | Small, 36.0 | 36.0 | | sourceFilters | [CompactFormFilter](#CompactFormFilter) | The query source filters. | Small, 48.0 | 48.0 | | sources | [CompactFormSource](#CompactFormSource) | The query sources. | Small, 48.9 | 48.0 | | totals | String | The query totals. | Small, 55.0 | 55.0 | | version | Double | The version of this query. | Small, 36.0 | 36.0 | ## CompactFormFilter | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | booleanFilterLogic | String | The boolean filter logic. | Small, 49.0 | 49.0 | | filters | Object | The list of filters. | Small, 48.0 | 48.0 | ## CompactFormSource

Property Name	Type	Description	Filter Group and Version	Available Version
`cogroupType`	ConnectWaveCompactFormCogroupTypeEnum	The compact form source cogroup type. Valid values are: Anti Inner Left Outer Right Semi	Small, 48.0	48.0
`columns`	CompactFormColumn	The compact form source columns.	Small, 48.0	48.0
`groups`	Object	The compact form source groups.	Small, 48.0	48.0
`filters`	Object	The compact form source column filters.	Small, 52.0	52.0
`name`	String	The compact form source name.	Small, 48.0	48.0

## CompactFormColumn | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field | Object | The compact form column field. | Small, 48.0 | 48.0 | | formula | String | The compact form column formula. | Small, 48.0 | 48.0 | | name | String | The name of the compact form column. | Small, 48.0 | 48.0 | # Lens State Input The state for an Analytics lens. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | options | [LensVisualizationOptionsInput](#LensVisualizationOptionsInput) | The configuration options for different lens visualizations. | Optional | 36.0 | | query | [QueryInput](#QueryInput) | The SAQL query to be used to create this lens. | If using any visualization type other than comparison table, you are required to specify this property. | 36.0 | ## QueryInput | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | aggregateFilters | Object | The compact form aggregate filters for the query. | Optional | 48.0 | | columnGroups | Object | The column groups for the query. | Optional | 56.0 | | columnTotals | Object | The column totals for the query. | Optional | 56.0 | | limit | Object | The query limit. | Optional | 48.0 | | orders | Object | The query orders. | Optional | 48.0 | | query | String | The SAQL query. | Optional for PATCH, required for POST | 36.0 | | rowTotals | Object | The row totals for the query. | Optional | 56.0 | | sourceFilters | Map | The map of compact form source filters for the query. | Optional | 48.0 | | sources | [CompactFormSourceInput](#CompactFormSourceInput)\[\] | The list of compact form sources for the query. | Optional | 48.0 | | timezone | String | The timezone for the query request. | Optional | 43.0 | | version | Double | Version to which this query language construct belongs. | Optional for PATCH, required for POST | 36.0 | ## CompactFormFilterInput | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | booleanFilterLogic | String | The boolean filter logic. | Optional | 49.0 | | filters | Object | The compact form filters. | Required | 48.0 | ## CompactFormSourceInput H

Property Name	Type	Description	Required or Optional	Available Version
`cogroupType`	ConnectWaveCompactFormCogroupTypeEnum	The compact form source cogroup type. Valid values are: Anti Inner Left Outer Right Semi	Required	48.0
`columns`	CompactFormColumnInput[]	The list of compact form source columns.	Required	48.0
`groups`	Object	The compact form source groups.	Required	48.0
`filters`	Object	The compact form source column filters.	Required	48.0
`name`	String	The compact form source name.	Required	52.0

## CompactFormColumnInput | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | Object | The compact form column field | Required | 48.0 | | formula | String | The formula for the compact form column. | Required | 48.0 | | name | String | The name of the compact form column. | Required | 48.0 | ## LensVisualizationOptionsInput | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | columnTotals | Boolean | Indicates whether to display column totals in the table (true) or not (false). | Optional | 55.0 | | fit | Boolean | Indicates whether to scale the position and size of data shape so that it’s proportional to its percentage of its category (true) or not (false). | Optional | 36.0 | | hideHeaderColumn | Boolean | Indicates whether to display header column (true) or not (false). | Optional | 36.0 | | legend | Boolean | Indicates whether to show legend (true) or not (false). | Optional | 36.0 | | legendHideHeader | Boolean | Indicates whether to hide the legend (true) or not (false). | Optional | 36.0 | | legendWidth | Integer | The width of the legend. | Optional | 36.0 | | maxColumnWidth | Integer | The maximum width of the header column. | Optional | 36.0 | | minColumnWidth | Integer | The minimum width of the header column. | Optional | 36.0 | | miniBars | Integer | The width of the miniBars, if present. | Optional | 36.0 | | multiMetrics | Boolean | Indicates whether multiple measures are projected on the same chart, side by side (true) , or if every measure is in its own chart (false). | Optional | 36.0 | | normalize | Boolean | Indicates whether to scale the position and size of data shape so that it’s proportional to its percentage of its category (true) or not (false). | Optional | 36.0 | | rowTotals | Boolean | Indicates whether to display row totals in the table (true) or not (false). | Optional | 55.0 | | splitAxis | Boolean | Indicates whether each measure is projected on one axis or if all measures share an axis (true) or not (false). | Optional | 36.0 | | sqrt | Boolean | Indicates whether the axis is sqrt scale (true) or not (false). | Optional | 36.0 | | subtotals | Boolean | Indicates whether to display subtotals in the table (true) or not (false). | Optional | 48.0 | | totals | Boolean | Indicates whether to display totals in the table (true) or not (false). | Optional | 36.0 | | trellis | Boolean | Indicates whether the last group is treated as a trellis dimension (true) or not (false). Every distinct value of the dimension is a chart. | Optional | 36.0 | # Lenses List Resource Returns a list of Analytics lenses or creates a lens. ## Resource URL /wave/lenses ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getLensCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-e5608103-f2d8-44dd-b3fb-c60195df2ec6?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Apex — [Wave.Lenses.getLenses()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_apex_query.htm) - Aura — [ listLenses()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) ## HTTP Methods GET POST ## GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`folderId`	ID	Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder.	Optional	36.0
`page`	String	A generated token that indicates the view of the lenses to be returned.	Optional	36.0
`pageSize`	Integer	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	36.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	36.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `CreatedByMe` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `App` `CreatedBy` `CreatedDate` `LastModified` `LastModifiedBy` `Mru` (Most Recently Used, last viewed date) `Name` `Type`	Optional	38.0

## GET Response Body [Lens Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens_collection.htm "A collection of Analytics lenses.") ## POST Response Body [Lens](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_lens.htm "Am Analytics lenses.") # License Attributes The Analytics license attributes. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	ConnectAnalyticsLicenseTypeEnum	The Analytics license type. Valid values are: `Cdp` (Data 360) `DataPipelineQuery` (Data Pipeline Query) `EinsteinAnalytics` (CRM Analytics) `IntelligentApps` (Intelligent Apps) `Sonic` (Salesforce Data Pipeline)	Small, 51.0	51.0

# License Attributes Input The Analytics license attributes. Properties

Property Name	Type	Description	Required and Optional	Available Version
`type`	ConnectAnalyticsLicenseTypeEnum	The Analytics license type. Valid values are: `Cdp` (Data 360) `DataPipelineQuery` (Data Pipeline Query) `EinsteinAnalytics` (CRM Analytics) `IntelligentApps` (Intelligent Apps) `Sonic` (Salesforce Data Pipeline)	Small, 51.0	51.0

# Limits Resource The Analytics limits for the Salesforce org. Resource URL /wave/limits Formats JSON Available Version 51.0 ## Available in Postman To view and test a working example of this resource, see [getWaveAnalyticsLimitCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-95b3c4f7-c88d-4fc2-8e48-3f47a5aebf1c?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). Available Components - LWC — [lightning/analyticsWaveApi getAnalyticsLimits()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_wire_adapters_get_analytics_limits) HTTP Methods GET Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`licenseType`	ConnectAnalyticsLicenseTypeEnum	Filters the results by the Analytics license type. Valid values are: `Cdp` (Data 360) `DataPipelineQuery` (Data Pipeline Query) `EinsteinAnalytics` (CRM Analytics) `IntelligentApps` (Intelligent Apps) `Sonic` (Salesforce Data Pipeline)	Optional	51.0
`types`	ConnectAnalyticsLimitTypeEnum	Filters the results by the type of limits used in Analytics. Valid values are: `BatchTransformationHours` (Maximum dataflow runtime per month) `DatasetQueries` (Maximum queries on datasets for all users) `DatasetRowCount` (Maximum row of all datasets combined) `MaxDailyRowsDataCloudOutputCon` (Maximum rows for Data 360 output per rolling 24-hour period) `MaxDailyRowsHighOutputCon` (Maximum rows for all high volume tier output connectors per rolling 24-hour period) `MaxDailyRowsLowOutputCon` (Maximum rows for all low volume tier output connectors per rolling 24-hour period) `MaxDailyRowsMedOutputCon` (Maximum rows for all medium volume tier output connectors per rolling 24-hour period) `MaxDailySizeHighOutputCon` (Maximum data size for all high volume tier output connectors per rolling 24-hour period) `MaxDailySizeLowOutputCon` (Maximum data size for all low volume tier output connectors per rolling 24-hour period) `MaxDailySizeMedOutputCon` (Maximum data size for all medium volume tier output connectors per rolling 24-hour period) `MaxDailySizeVirtualPrivateCloudCon` (Maximum cumulative bytes of data sent through connections using a virtual private cloud in a rolling 24-hour period) `MaxDailyUploadVolume` (Maximum cumulative bytes of data files uploaded to Salesforce in a rolling 24-hour period) `MaxDailyWorkflowExecutions` (Maximum number of dataflow and recipe runs in a rolling 24-hour period) `MaxRecipeOutRowsPerMonth` (Maximum number of rows output by all recipes to all datasets in a month) `MaxReplicatedObjects` (Maximum number of connected objects) `OutputLocalConnectorVolume` (Maximum cumulative bytes of data files written to Salesforce in a rolling 24-hour period) `StagedDatasetRowCount` (Maximum rows for staged datasets)	Optional	51.0

Response body for GET [Wave Analytics Limit Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_analytics_limit_collection.htm "The collection of Analytics limits.") # Link Asset Destination A link to an Analytics asset. Properties | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The destination asset name. | Small, 48.0 | 48.0 | | namespace | String | The destination asset namespace. | Small, 48.0 | 48.0 | | pageName | String | The destination asset page name. | Small, 48.0 | 48.0 | | savedViewId | String | The dashboard saved view ID. | Small, 48.0 | 48.0 | | widgetId | String | The widget ID. | Small, 48.0 | 48.0 | # Link Box Item A link box item on a panel for an Analytics template wizard page. ## Properties Inherits properties from [Panel Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm "An item on a panel in a column layout for an Analytics template wizard page."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | icon | String | The icon for the link. | Small, 59.0 | 59.0 | | text | String | The text for the link. | Small, 59.0 | 59.0 | | title | String | The title for the link box. | Small, 59.0 | 59.0 | | url | String | The URL for the link. | Small, 59.0 | 59.0 | # Literal Json A string of JSON content results, usually for a query response. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | json | String | The JSON content to be serialized | Small, 36.0 | 36.0 | #### See Also - [Query Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_query.htm "Executes a query written in Salesforce Analytics Query Language (SAQL) or SQL for CRM Analytics.") # Live Connection The connection details of an Analytics live dataset. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`connectionLabel`	String	The label of the live connection.	Small, 50.0	50.0
`connectionName`	String	The developer name of the live connection.	Small, 50.0	50.0
`connectionType`	ConnectWaveDataConnectorTypeEnum	The type of Analytics connector. Valid values are: `AmazonAthena` `AmazonRedshiftOutput` `AmazonS3` `AmazonS3Output` `AmazonS3Private` `AwsRdsAuroraMySQL` `AwsRdsAuroraPostgres` `AwsRdsMariaDB` `AwsRdsMySQL` `AwsRdsPostgres` `AwsRdsPostgresPrivate` `AwsRdsSqlServer` `AzureDataLakeGen2Output` `AzureSqlDatabase` `AzureSqlDatawarehouse` `Databricks (Beta)` `GoogleAnalytics4` `GoogleBigQuery` `GoogleBigQueryDirect` `GoogleBigQueryStandardSQL` `GoogleSpanner` `HerokuPostgres` `HubSpot` `MarketoV2` `NetSuite` `OracleEloqua` `Redshift` `RedshiftPrivate` `SalesforceExternal` `SalesforceMarketingCloudOAuth2` `SapHanaCloud` `SfdcLocal` `SnowflakeComputing` `SnowflakeDirect` `SnowflakeOutput` `SnowflakePrivate` `SnowflakePrivateOutput` `TableauOnline` `TableauHyperOutput` `Zendesk` .	Small, 53.0	53.0
`sourceObjectName`	String	The source object name for the live connection.	Small, 50.0	50.0

# Live Connection Input The connection details of an Analytics live dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | connectionName | String | The developer name of the live connection. | Required | 50.0 | | sourceObjectName | String | The source object name for the live connection. | Required | 50.0 | # Macro Definition A macro definition that is part of a larger macro for a JSON transformation rule. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | actions | [ActionInpu](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_action_input.htm "The action for a rule or macro to perform during a JSON transformation.")\[\] | A list of actions for the macro. | Required | 43.0 | | description | String | The description of the macro. | Optional | 43.0 | | name | String | The name of the macro. | Required | 43.0 | | parameters | String\[\] | A list of parameters for the macro. | Required | 43.0 | | returns | Object | The returns of evaluated expression results of the macro when the action is eval. | Optional | 43.0 | # Macro Input A macro to use for a JSON transformation rule. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | definitions | [MacroDefinition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_macro_definition.htm "A macro definition that is part of a larger macro for a JSON transformation rule.")\[\] | A list of macro definitions. | Required | 43.0 | | namespace | String | The namespace of the macro. | Required | 43.0 | # Map A map object. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`boundingBox`	BoundingBox	The bounding box of the geo map	Small, 38.0	39.0
`createdBy`	User	The creator of the map	Small, 38.0	38.0
`createdDate`	Date	The date when this map was created	Small, 38.0	38.0
`geoData`	GeoData	The geo data of the map	Small, 38.0	38.0
`id`	String	The 18 character map ID	Small, 38.0	38.0
`label`	String	The map label	Small, 39.0	39.0
`name`	String	The map developer name.	Small, 39.0	39.0
`namespace`	String	The namespace that qualifies the map	Small, 39.0	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	The map projection. Valid values are: `AlbersUSA` `Equirectangular` `Mercator`	Small, 38.0	38.0
`url`	String	The url to the map representation	Small, 38.0	38.0

#### See Also - [Charts Maps List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps.htm "Returns a list of maps or creates a map.") - [Charts Maps Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps_id.htm "Returns, updates, or deletes a specific map.") # Map Bounding Box Input A bounding box of a map.. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | bottom | Double | The bottom boundary of the geo map | Required | 39.0 | | left | Double | The left boundary of the geo map | Required | 39.0 | | right | Double | The right boundary of the geo map | Required | 39.0 | | top | Double | The top boundary of the geo map | Required | 39.0 | # Map Collection A collection of maps. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | maps | [Map](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_map.htm "A map object.")\[\] | The list of the maps. | Small, 38.0 | 38.0 | #### See Also - [Charts Maps List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps.htm "Returns a list of maps or creates a map.") # Map Input A map for an Eclair chart. Properties

Property Name	Type	Description	Required or Optional	Available Version
`boundingBox`	MapBoundingBoxInput	The map bounding box.	Optional	39.0
`geoData`	AssetReferenceInput	The parent geodata asset.	Required	39.0
`label`	String	The map label.	Required	39.0
`name`	String	The map developer name.	Optional	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	The map projection. Valid values are: `AlbersUSA` `Equirectangular` `Mercator`	Required	39.0

#### See Also - [Charts Maps List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps.htm "Returns a list of maps or creates a map.") - [Charts Maps Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_eclair_maps_id.htm "Returns, updates, or deletes a specific map.") # Mapped SDM A mapped Tableau Next semantic model. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID of the mapped semantic model | Small, 67.0 | 67.0 | | label | String | The label of the mapped semantic model | Small, 67.0 | 67.0 | | name | String | The API name of the mapped semantic model | Small, 67.0 | 67.0 | # Mapped SDM Input A mapped Tableau Next semantic model. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID of the mapped semantic model | Required | 67.0 | | label | String | The label of the mapped semantic model | Required | 67.0 | | name | String | The API name of the mapped semantic model | Required | 67.0 | # Minutely Schedule Specify a schedule that runs multiple times an hour for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.")

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 45.0	45.0
`lastHour`	Integer	Hour of day at which the schedule stops queuing the asset for processing.	Small, 45.0	45.0
`minutelyInterval`	Integer	Number of minutes in between queuing or scheduling of an asset.	Small, 45.0	45.0

# Minutely Schedule Input Specify a sub-hourly schedule for an Analytics asset. Properties Inherits notification, and time from [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset.")

Property Name	Type	Description	Required or Optional	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Required	45.0
`lastHour`	Integer	Hour of day at which the schedule stops queuing the asset for processing.	Required	45.0
`minutelyInterval`	Integer	Number of minutes in between queuing or scheduling of an asset.	Required	45.0

# Monthly Relative Schedule Specify a schedule that runs monthly on a relative day within the month for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.")

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 39.0	39.0
`weekInMonth`	ConnectWaveRelativeWeekEnum	Week within a month. Values values are: `First` `Second` `Third` `Fourth` `Last`	Small, 39.0	39.0

# Monthly Relative Schedule Input Specify a monthly schedule for an Analytics asset where the day are relative to their location in the week. Properties Inherits notification, and time from [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset.")

Property Name	Type	Description	Required or Optional	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Required	39.0
`weekInMonth`	ConnectWaveRelativeWeekEnum	Week within a month. Values values are: `First` `Second` `Third` `Fourth` `Last`	Required	39.0

# Monthly Specific Schedule Specify a schedule that runs monthly on a specific day within the month for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.") | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | daysOfMonth | Integer\[\] | Days of the month on which the schedule runs (1-31). Months lacking specific days will skip the job. | Small, 39.0 | 39.0 | # Monthly Specific Schedule Input Specify a monthly schedule for an Analytics asset where the days are fixed by numerical date. Properties Inherits notification, and time from [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset.") | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | daysOfMonth | Integer\[\] | Days of the month on which the schedule runs (1-31). Months lacking specific days will skip the job. | Required | 39.0 | # Navigation Panel The navigation panel for a template configuration wizard page. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | title | String | The title for the navigation panel on a template wizard page. | Small, 59.0 | 59.0 | # Node Row Count The node row count for an Analytics dataflow job node. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | failedCount | Long | The number of failed rows for the node. | Small, 50.0 | 50.0 | | processedCount | Long | The number of processed rows for the node. | Small, 50.0 | 50.0 | # Notification Action A notification action for an Analytics subscription. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`configuration`	BaseNotificationActionConfiguration	The action configuration. Valid values are: PostToSlackNotificationActionConfiguration SendToEmailNotificationActionConfiguration	Small, 53.0	53.0
`type`	NotificationActionType	The notification action type. Valid values are: `PostToSlack` `SendEmail`	Small, 53.0	53.0

# Notification Action Input A notification action for an Analytics subscription. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`configuration`	BaseNotificationActionConfigurationInput	The action configuration. Valid values are: PostToSlackNotificationActionConfigurationInput SendToEmailNotificationActionConfigurationInput	Small, 53.0	53.0
`type`	NotificationActionType	The notification action type. Valid values are: `PostToSlack` `SendEmail`	Small, 53.0	53.0

# Number Type The number type of an Analytics template variable. ## Properties Inherits properties from [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable.").

Property Name	Type	Description	Filter Group and Version	Available Version
`enums`	Double[]	The restricted list of enumerated numeric values.	Small, 36.0	36.0
`enumsLabels`	String[]	The optional list of display labels for the enumerated values.	Small, 58.0	58.0
`format`	NumberTypeFormatEnum	The format for the number type. Valid values are: `Currency` `Decimal` `Percent` `PercentFixed`	Small, 59.0	59.0
`max`	Double	The maximum allowed value of the number.	Small, 36.0	36.0
`min`	Double	The minimum allowed value of the number.	Small, 36.0	36.0
`scale`	Integer	The maximum scale of the number where scale defines the digits after the decimal point.	Small, 59.0	59.0

# Numeric Separators The numeric separators for thousands and decimals, used in formatting. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | decimal | String | The decimal separator. Default is the .(period) symbol, but it can be customized via the custom format. | Small, 48.0 | 48.0 | | thousands | String | The thousands separator. Default is the ,(comma) symbol, but it can be customized via the custom format. | Small, 48.0 | 48.0 | # Object Coverage The security coverage for a source object. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | eligibleSharingSource | Boolean | Indicates whether the object is an eligible sharing source or not. | Small, 41.0 | 41.0 | | label | String | The label of the object. | Small, 41.0 | 41.0 | | name | String | The name of the object. | Small, 41.0 | 41.0 | | namespace | String | The namespace of the object. | Small, 41.0 | 41.0 | | unsupportedRecords | [UnsupportedRecordCollection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_unsupported_record_collection.htm "The collection of specific records that unsupported for sharing inheritance.") | The specific records that are unsupported for sharing inheritance. | Small, 50.0 | 50.0 | | url | String | The URL for retrieving this information. | Small, 41.0 | 41.0 | #### See Also - [Security Coverage Object Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_security_coverage_object.htm "Returns the security coverage for a particular object. Use this API to discover whether Analytics can inherit sharing settings from an object.") # Object Type The object type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). # Output Source The output source for an Analytics replicated dataset, also known as a connected object. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | inputRows | Integer | The number of input rows for the sync out operation. | Small, 50.0 | 50.0 | | isSyncOut | Boolean | Indicates whether this object represents a sync out connection (true) or a recipe output connection (false). | Small, 50.0 | 50.0 | | nextScheduledDate | Date | The next scheduled run time for the output source. | Small, 50.0 | 50.0 | | outputRows | Integer | The number of output rows for the sync out operation. | Small, 50.0 | 50.0 | # Page A UI page for an Analytics template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | condition | String | The optional condition to determine if the page is visible or not. Values are client-side EL notation (such as {{Variables.selectedOption}}). | Small, 36.0 | 36.0 | | helpUrl | String | A URL to this page's help webpage. | Small, 36.0 | 36.0 | | title | String | The title for the page. | Small, 36.0 | 36.0 | | variables | [PageVariable](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_variable.htm "An Analytics variable to display on a UI page.")\[\] | The collection of variables for this template configuration. | Small, 36.0 | 36.0 | | vfPage | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The Visualforce page to be used as the wizard user interface instead of the standard wizard interface. | Small, 40.0 | 40.0 | # Page Layout The page layout definition for an Analytics template. ## Properties Inherited by [Configuration Page Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_configuration_page_layout.htm "The configuration page layout for a template configuration wizard page.") and [Validation Page Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_validation_page_layout.htm "The validation page layout for a template configuration wizard page.").

Property Name	Type	Description	Filter Group and Version	Available Version
`backgroundImage`	AssetReference	The optional background image for the page.	Small, 56.0	56.0
`condition`	String	A optional condition to specify whether the page should be shown or not. Values must be in client-side EL notation. For example, `{{Variables.selectedOption}}.`	Small, 56.0	56.0
`guidancePanel`	GuidancePanel	The guidance panel for the page.	Small, 59.0	59.0
`helpUrl`	String	The URL to help content for this page.	Small, 56.0	56.0
`navigation`	PageNavigationInfo	The navigation information for this page.	Small, 59.0	59.0
`title`	String	The title for this page.	Small, 56.0	56.0
`type`	PageTypeEnum	The page type. Valid values are: `Configuration` `Validation`	Small, 59.0	59.0

# Page Navigation Info The navigation information for a template configuration wizard page. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The label for the navigation panel on a template wizard page. | Small, 59.0 | 59.0 | | parentLabel | String | The label for the parent page on a template wizard page. | Small, 59.0 | 59.0 | # Page Variable An Analytics variable to display on a UI page. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of a variable. | Small, 36.0 | 36.0 | | visibility | String | The visibility expression for this variable | Small, 36.0 | 36.0 | # Panel A panel in a column layout for an Analytics template wizard page. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`items`	PanelItem[]	A list of items for the panel. Valid values are: ImageItem TextItem VariableItem	Small, 56.0	56.0

# Panel Item An item on a panel in a column layout for an Analytics template wizard page. ## Properties Inherited by [Group Box Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_group_box_item.htm "A group box item on a panel for an Analytics template wizard page."), [Image Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_image_item.htm "An image item on a panel for an Analytics template wizard page."), [Link Box Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_link_box_item.htm "A link box item on a panel for an Analytics template wizard page."), [Text Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_text_item.htm "A text item on a panel for an Analytics template wizard page."), and [Variable Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_item.htm "A variable item on a panel for an Analytics template wizard page.")

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	PanelItemTypeEnum	The panel item type. Valid values are: `GroupBox` `Image` `LinkBox` `Text` `Variable`	Small, 56.0	56.0
`visibility`	String	The visibility expression for the panel.	Small, 56.0	56.0

# Permissions The user permissions for an Analytics asset. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | create | Boolean | Indicates whether the user can create an asset (true) or not (false). | Small, 45.0 | 45.0 | | manage | Boolean | Indicates whether the user can manage access on the asset (true) or not (false). | Small, 36.0 | 36.0 | | modify | Boolean | Indicates whether the user can modify the asset (true) or not (false). | Small, 36.0 | 36.0 | | view | Boolean | Indicates whether the user can view the asset (true) or not (false). | Small, 36.0 | 36.0 | # Post To Slack Notification Action Configuration The notification action configuration for posting to Slack. Properties PostToSlackNotificationActionConfiguration inherits properties from the abstract [BaseNotificationActionConfiguration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_notification_action_configuration.htm "The base Analytics notification action configuration."). These base properties appear in PostToSlackNotificationActionConfiguration alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | excludeSnapshot | Boolean | Indicates whether a snapshot is excluded in the dashboard subscription (true) or not (false). | Small, 54.0 | 54.0 | | recipients | [CollaborationRoomNotificationRecipient](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_collaboration_room_notification_recipient.htm "The Slack recipient of a notification.")\[\] | The collection of notification recipients. | Small, 53.0 | 53.0 | | team | [SlackReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_slack_reference.htm "The reference for a Slack entity.") | The team of notification recipients. | Small, 53.0 | 53.0 | # Post To Slack Notification Action Configuration Input The notification action configuration for posting to Slack. Properties PostToSlackNotificationActionConfigurationInput inherits properties from the abstract [BaseNotificationActionConfigurationInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_notification_action_configuration_input.htm "The base Analytics notification action configuration."). These base properties appear in PostToSlackNotificationActionConfigurationInput alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | excludeSnapshot | Boolean | Indicates whether a snapshot is excluded in the dashboard subscription (true) or not (false). | Optional | 54.0 | | recipients | [CollaborationRoomNotificationRecipientInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_collaboration_room_notification_recipient_input.htm "The Slack recipient of a notification.")\[\] | The collection of notification recipients. | Required | 53.0 | | team | [SlackReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_slack_reference_input.htm "The reference for a Slack entity.") | The team of notification recipients. | Required | 53.0 | # Prerequisites Complete these prerequisites before you begin the quick start. - Download and install the [Postman Desktop App](https://www.postman.com/downloads/ "HTML (New Window)"). - Generate a private-public keypair (.key and .crt files) on your [Mac](https://learn.microsoft.com/en-us/viva/glint/setup/sftp-ssh-key-gen#create-an-ssh-key-pair-on-macintosh-or-linux "HTML (New Window)") or [Microsoft® Windows®](https://learn.microsoft.com/en-us/viva/glint/setup/sftp-ssh-key-gen#create-an-ssh-key-pair-on-microsoft-windows "HTML (New Window)")machine if you haven’t already done so. - Sign up for a [Trailhead Playground org](https://trailhead.salesforce.com/promo/orgs/analytics-de) with CRM Analytics enabled. # Property Condition A condition where the connection property is visible. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | key | String | The name of the select option. | Small, 66.0 | 66.0 | | label | String | The label of the select option. | Small, 66.0 | 66.0 | | value | String | The values of the select option. | Small, 66.0 | 66.0 | # Property Option A value option for Select connection properties. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | propKey | String | A name of the connection property with a condition. | Small, 66.0 | 66.0 | | values | String\[\] | A list of values for the connection property. | Small, 66.0 | 66.0 | # Query A query written in SAQL or compact form. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | aggregateFilters | Object | The query aggregate filters. | Small, 48.0 | 48.0 | | columnGroups | Object | The query column groups. | Small, 56.0 | 56.0 | | columnTotals | Object | The query column totals. | Small, 56.0 | 56.0 | | limit | Object | The query limit. | Small, 48.0 | 48.0 | | orders | Object | The query orders. | Small, 48.0 | 48.0 | | query | String | The SAQL query text. | Small, 36.0 | 36.0 | | rowTotals | Object | The query row totals. | Small, 56.0 | 56.0 | | sourceFilters | [CompactFormFilter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_compact_form_filter.htm "A compact form filter.") | The query source filters. | Small, 48.0 | 48.0 | | sources | [CompactFormSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_compact_form_source.htm "A compact form source for a query.") | The query sources. | Small, 48.9 | 48.0 | | version | Double | The version of this query. | Small, 36.0 | 36.0 | # Query CRM Analytics Data with the Query API Use the CRM Analytics REST API to directly query analytics data using SAQL or SQL queries. ## Execute Analytics Queries Programmatically You can use a REST API to query analytics datasets using either SAQL or SQL query statements. The query endpoint is wave/query and takes a POST request body using a [SAQL Query Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_saql_query_input.htm "An Analytics query written in SAQL or SQL.") to execute the query. ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note You can use the Lightning Web Component lightning/analyticsWaveApi module to bring this functionality into Salesforce, without proxying REST APIs directly. For more information, see the reference section for the [executeQuery](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/lwc.reference_analytics_execute_query) function. Example SAQL Query Request For SAQL queries executed using REST API, you must have both the dataset ID and the dataset version ID to specify the dataset you want to query. Using the name of the dataset in the query returns an error. The only required attribute for the request is query. { "query" : "q = load "/"; q = group q by 'Status'; q = foreach q generate 'Status' as 'Status', count() as 'count'; q = limit q 20;", "queryLanguage" : "SAQL" } Example SAQL Query Response The response results include metadata and records. It also returns the original query and the response time. If there are warnings or errors, warnings is included. For the SAQL query executed in the previous example, here’s the response: { "action" : "query", "responseId" : "4l-kl6BTnH4ay9-qbx2Re-", "results" : { "metadata" : \[ { "lineage" : { "type" : "foreach", "projections" : \[ { "field" : { "id" : "q.Status", "type" : "string" }, "inputs" : \[ { "id" : "q.Status" } \] }, { "field" : { "id" : "q.count", "type" : "numeric" } } \], "input" : { "type" : "group", "groups" : \[ { "id" : "q.Status" } \] } }, "queryLanguage" : "SAQL" } \], "records" : \[ { "Status" : "Closed", "count" : 7 }, { "Status" : "Open", "count" : 6 } \] }, "query" : "q = load "/"; q = group q by 'Status'; q = foreach q generate 'Status' as 'Status', count() as 'count'; q = limit q 20;", "responseTime" : 3, "warnings" : \[ { "code" : "001", "message" : "Limit exceeded" }, { "code" : "002", "message" : "Another warning..." } \] } Example SQL Request Body The default language for query execution is SAQL. To use SQL, include the attribute "queryLanguage" : "SQL" in your request. For SQL queries, you can use the dataset name. Here’s the same query request in SQL. { "query" : "SELECT Status, COUNT(\*) as StatusCount FROM "" GROUP BY Status LIMIT 20;", "queryLanguage": "SQL" } ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If you forget to specify "queryLanguage" : "SQL", the request returns a syntax error. Example SQL Query Response The response records look the same as the SAQL response, but the metadata is different. The columns key includes the name and type of projections in the query. { "action" : "query", "responseId" : "4l-mtW26NZ4OYu-qbx3GN-", "results" : { "metadata" : \[ { "columns" : \[ { "columnLabel" : "Status", "columnType" : "varchar" }, { "columnLabel" : "StatusCount", "columnType" : "numeric" } \], "queryLanguage" : "SQL" } \], "records" : \[ { "Status" : "Closed", "StatusCount" : 7 }, { "Status" : "Open", "StatusCount" : 6 } \] }, "query" : "SELECT Status, COUNT(\*) as StatusCount FROM "Cases1" GROUP BY Status LIMIT 20;", "responseTime" : 9 } Example SQL Metadata: Group By Query With an Aggregation The query projects the aggregation avg(Sales) as AvgSales, which returns numerical data. In the metadata, the corresponding column type is returned as numeric. "metadata": \[ "columns": \[ { "columnLabel": "City", "columnType": "varchar" }, { "columnLabel": "AvgSales", "columnType": "numeric" } \], "queryLanguage": "SQL" \] Example SQL Query and Response Body: Extract Date Parts from a Date Field This example returns the year, month, and day from the CloseDate field as numerical values. The request features the timezone attribute, which is attribute is optional and can only be used if timezone is enabled for the org. { "query" : "SELECT EXTRACT(YEAR FROM CloseDate) as year, EXTRACT(MONTH FROM CloseDate) as month, EXTRACT(DAY FROM CloseDate) as day From "OpportunityFiscalEM" "queryLanguage" : "SQL", "timezone" : "America/Los\_Angeles" } "metadata": \[ "columns": \[ { "columnLabel": "year", "columnType": "numeric" }, { "columnLabel": "month", "columnType": "numeric" }, { "columnLabel": "day", "columnType": "numeric" } \], "timezone": "America/Los\_Angeles", "queryLanguage": "SQL" \] Example SQL Query and Response Body: Project Date Field of Type DateTime This query returns date information as timestamps. { "query" : "SELECT CloseDate From "OpportunityFiscalEM", "queryLanguage" : "SQL" } "metadata": \[ "columns": \[ { "columnLabel": "CloseDate", "columnType": "timestamp" } \], "queryLanguage": "SQL" \] Query Metadata Details Clients can parse the queries to figure out what dimensions and groups are used, but this can be expensive. So, in most cases, the query response contains a metadata section, which provides grouping and column information. The metadata section, if present, is found in the results key in the query response payload. The metadata section is structured with columns and groups keys: "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 in the query. ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note - The metadata is added when the query is successful. If the query fails to run, if there’s a syntax error, or if the authorization callback fails then the metadata isn’t 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 is returned in the groups key, provided the query isn’t considered complex—where the group name returned is nondeterministic (the name of the group is used in multiple streams of the query). This is the case when the query uses cogroup or union. In such cases, the groups key is empty. #### See Also - [Analytics SAQL Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_saql.meta/bi_dev_guide_saql/bi_saql_intro.htm) - [SQL for Analytics Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sql.meta/bi_dev_guide_sql/bi_sql_intro.htm) # Query Resource Executes a query written in Salesforce Analytics Query Language (SAQL) or SQL for CRM Analytics. Resource URL /wave/query Formats JSON Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [postQuery](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-78ef861a-f5e0-46dd-b43d-150275044da1?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). Available Components - Apex — [Wave.executeQuery()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_apex_query.htm) - Aura — [ executeQuery()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_asset.htm) - LWC — [lightning/analyticsWaveApi executeQuery()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_analytics_execute_query) HTTP Methods POST Request body for POST [SaqlQueryInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_saql_query_input.htm "An Analytics query written in SAQL or SQL.") Response body for POST [Literal JSON](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_literal_json.htm "A string of JSON content results, usually for a query response.") Execute a Query For examples of how to execute SAQL and SQL queries, see [Query CRM Analytics Data with the Query API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_api_query_data.htm "Use the CRM Analytics REST API to directly query analytics data using SAQL or SQL queries."). # Quick Start Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response. - **[Prerequisites](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/prerequisites.htm)** Complete these prerequisites before you begin the quick start. - **[Configure Your Trailhead Org](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_configure_your_trailhead_org.htm)** To configure your Trailhead org, set up Cross-Origin Resource Sharing (CORS) and a connected app. - **[Authenticate to Your Trailhead Playground Org](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/authenticate_to_your_trailhead_playground_org.htm)** After configuring the connected app, you must authorize your user with the connected app. - **[Set Up Your Postman Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/set_up_postman_collection.htm)** Set up Postman to work with the Salesforce CRM Analytics Connect API collection. - **[Use Postman to Send a CRM Analytics Request](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_send_postman_request.htm)** With Postman, you can explore and test your CRM Analytics API calls across multiple organizations with full control on headers, parameters, and content type. # Recipe Resources Recipes are used to prepare data, creating a dataset using transformations to manipulate the data. Recipes prepare data for use in Analytics and the Customer Data Platform. For reference content, see the [Data Prep Recipe REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_overview.htm). # Replicated Dataset An Analytics replicated dataset, also know as a connected object. Properties ReplicatedDataset inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear alongside ReplicatedDataset specific properties in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`advancedProperties`	AdvancedPropertyValue	The advanced properties associated with this connected object.	Small, v44.0	44.0
`connectionMode`	ConnectWaveConnectionModeEnum	The connection mode for data sync. For faster extracts, use `Incremental` or `PeriodicFull`. Valid values are: `Full` `Incremental` `PeriodicFull`	Small, 46.0	46.0
`connector`	DataConnector	Analytics connector information associated with this connected object	Small, 37.0	37.0
`datasetId`	String	The ID of the dataset for the connected object.	Small, 38.0	38.0
`datasetLabel`	String	The label of the dataset for the connected object.	Small, 56.0	56.0
`fieldCount`	Integer	The number of columns in the connected object.	Small, 38.0	38.0
`fieldsUrl`	String	URL to get the fields associated with the connected object.	Small, 37.0	37.0
`filterApplied`	Boolean	Indicates whether filters have been applied to this connected object (`true`) or not (`false`).	Small, 38.0	38.0
`folderId`	String	The ID of the folder associated with the dataset for the connected object.	Small, 56.0	56.0
`incrementalOn`	Boolean	Indicates whether this connected object is incrementally synced `true`) or not (`false`).	Small, 38.0	38.0-45.0
`lastRefreshedDate`	Date	The date when this connected object was last synced.	Small, 38.0	38.0
`outputSource`	OutputSource	The output source, either a recipe or a connection, configured for this connected object.	Small, 50.0	50.0
`parquetOutputEnabled`	Boolean	Indicates whether to provide output in parquet format (`true`) or not (`false`).	Small, 50.0	60.0
`passThroughFilter`	String	The pass through filter string for this connected object.	Small, 38.0	38.0
`replicationDataflowId`	String	The data sync job ID used to populate this connected object.	Small, 41.0	41.0
`rowLevelSharing`	String	Inherit row level sharing rules for this connected object.	Small, 44.0	44.0
`sourceObjectName`	String	The name of the source object to sync.	Small, 37.0	37.0
`status`	ReplicatedDataflowStatusEnum	The status of the connected object. Valid values are: `Cancelled` `Checkpoint` `Dequeued` `Enqueued` `Failure` `Initiated` `New` `Serviced` `Stale` `Success` `Warnings`	Small, 38.0	38.0
`supportedConnectionModes`	ConnectWaveConnectionModeEnum[]	The connection mode for data sync. For faster extracts, use `Incremental` or `PeriodicFull`. Valid values are: `Full` `Incremental` `PeriodicFull`	Small, 46.0	46.0
`uuid`	String	The unique identifier for this dataset.	Small, 54.0	54.0

Property Name	Type	Description	Required or Optional	Available Version
`advancedProperties`	AdvancedPropertyValueInput	The user-specified advanced properties associated with this connected object.	Optional	44.0
`connectionMode`	ConnectWaveConnectionModeEnum	The connection mode for data sync. For faster extracts, use `Incremental` or `PeriodicFull`. Valid values are: `Full` `Incremental` `PeriodicFull`	Optional	46.0
`connectorId`	String	The id of the Analytics connector used to sync this connected object.	Required	39.0
`parquetOutputEnabled`	Boolean	Indicates whether to provide output in parquet format (`true`) or not (`false`).	Optional	60.0
`fullRefresh`	Boolean	Indicates whether to perform a one-time full refresh during the next run (`true`) as opposed to an incremental refresh (`false`).	Optional	41.0
`passThroughFilter`	String	The pass through filter for the connected object	Optional	38.0
`sourceObjectName`	String	The name of the source object to be synced.	Required	37.0

#### See Also - [Replicated Datasets List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets.htm "Returns a list of replicated datasets, also know as connected objects.") - [Replicated Dataset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id.htm "Returns, updates, and deletes replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset.") # Replicated Dataset Resource Returns, updates, and deletes replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset. ## Resource URL /wave/replicatedDatasets/ ## Formats JSON ## Available Version 37.0 ## Available in Postman To view and test a working example of this resource, see [getReplicatedDataset](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-9880bb3c-d6a3-40d9-b3ef-25c107407fe7?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## HTTP Methods DELETE GET PATCH ## Available Components - LWC — [lightning/analyticsWaveApi deleteReplicatedDataset()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-delete-replicated-dataset.html) - LWC — [lightning/analyticsWaveApi getReplicatedDataset()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-replicated-dataset.html) ## Response body for GET and PATCH [Replicated Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_dataset.htm "An Analytics replicated dataset, also know as a connected object.") ## Request body for PATCH [Replicated Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_replicated_dataset_input.htm "An Analytics replicated dataset, also know as a connected object.") The following JSON shows how to update an existing connected object by adding a pass through filter and setting the connection mode to Full. { "passThroughFilter": "(FiscalQuarter = 2 OR FiscalQuarter = 3) AND Amount > 1000 AND Amount <= 20000", "connectionMode": "Full" } # Replicated Dataset Resources Manage Analytics replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Replicated Datasets List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets.htm "Returns a list of replicated datasets, also know as connected objects.") | Returns a collection of replicated datasets, also know as connected objects. | GET POST | wave/replicatedDatasets | | [Replicated Dataset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id.htm "Returns, updates, and deletes replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset.") | Returns, updates, and deletes replicated datasets. | GET PATCH DELETE | /wave/replicatedDatasets/ | | [Replicated Dataset Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id_fields.htm "Retrieves a list of fields for the specified connected object.") | Returns a collection of fields for the specified connected object. | GET POST PATCH | /wave/replicatedDatasets//fields | - **[Replicated Datasets List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets.htm)** Returns a list of replicated datasets, also know as connected objects. - **[Replicated Dataset Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id.htm)** Returns, updates, and deletes replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset. - **[Replicated Dataset Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id_fields.htm)** Retrieves a list of fields for the specified connected object. # Replicated Datasets List Resource Returns a list of replicated datasets, also know as connected objects. ## Resource URL /wave/replicatedDatasets ## Formats JSON ## Available Version 37.0 ## Available in Postman To view and test a working example of this resource, see [getReplicatedDatasetCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-4d63c328-18e7-42e1-9b32-1ab5a4c47a8a?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getReplicatedDatasets()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-replicated-datasets.html) - LWC — [lightning/analyticsWaveApi createReplicatedDataset()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-create-replicated-dataset.html) ## HTTP Methods GET POST ## Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`category`	ConnectWaveReplicatedDatasetCategoryEnum	The category for connected objects. Valid values are: `Input` `Output`	Optional	50.0
`connector`	String	Filter the list of returned connected objects by specifying the name of an Analytics connector.	Optional	37.0
`includeLive`	Boolean	Indicates whether to include live datasets in the list (`true`) or not (`false`).	Optional	56.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	53.0
`sourceObject`	String	Filter the list of returned connected objects by specifying the name of a source object.	Optional	37.0

## Response body for GET [Replicated Dataset Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_dataset_collection.htm "A collection of Analytics replicated datasets, also know as connected objects.") ## Request body for POST [Replicated Dataset Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_replicated_dataset_input.htm "An Analytics replicated dataset, also know as a connected object.") The following JSON shows how to create a connected object from an Analytics connector. { "connectorId": "0ItS7000000xxxxxxx", "sourceObjectName": "Account" } ## Response body for POST [Replicated Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_dataset.htm "An Analytics replicated dataset, also know as a connected object.") # Replicated Field A field for an Analytics replicated dataset, also known as a connected object. Properties ReplicatedField inherits properties from the abstract [AbstractField](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_abstract_field.htm "The base definition of a dataset field."). These base properties appear in ReplicatedField alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accessDeniedReason | String | The message describing why a field is inaccessible. | Small, 68.0 | 68.0 | | accessible | Boolean | Indicates whether this field is accessible (true) or not (false). | Small, 68.0 | 68.0 | | skipped | Boolean | If set to true, this field isn’t synced, but the field metadata can still be stored and retrieved. | Small, 37.0 | 37.0 | #### See Also - [Replicated Dataset Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id_fields.htm "Retrieves a list of fields for the specified connected object.") # Replicated Field Collection A collection of fields for an Analytics replicated dataset, also known as a connected object. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [ReplicatedField](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_replicated_field.htm "A field for an Analytics replicated dataset, also known as a connected object.")\[\] | A list of fields belonging to the connected object. | Small, 37.0 | 37.0 | | replicatedDataset | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | A reference to the replicated dataset that the fields belong to. | Small, 53.0 | 53.0 | | sourceObjectParam | [SourceObjectData](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object_data.htm "The data retrieved from a source object given a list of fields and advanced properties.") | The source object data used to filter the fields. | Small, 67.0 | 67.0 | | url | String | URL to get the collection. | Small, 37.0 | 37.0 | #### See Also - [Replicated Dataset Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id_fields.htm "Retrieves a list of fields for the specified connected object.") # Replicated Field Collection Input A collection of fields for an Analytics replicated dataset, also known as a connected object. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [ReplicatedFieldInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_replicated_field_input.htm "A field for an Analytics replicated dataset, also known as a connected object.")\[\] | The list of field configurations. | Required | 37.0 | | sourceObjectParam | [SourceObjectDataInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_object_data_input.htm "The request to retrieve data from a source object given a list of fields and advanced properties.") | The source object data used to filter the fields. | Optional | 67.0 | #### See Also - [Replicated Dataset Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_replicateddatasets_id_fields.htm "Retrieves a list of fields for the specified connected object.") # Replicated Field Input A field for an Analytics replicated dataset, also known as a connected object. Properties

Property Name	Type	Description	Required or Optional	Available Version
`defaultValue`	Object	An optional default value.	Optional	37.0
`description`	String	A long-form description of the field.	Optional	37.0
`fieldType`	ConnectWaveFieldTypeEnum	The type of the field. Valid values are: `Date` `Numeric` `Text` Note When Analytics custom time zone support is enabled, use `DateTime` or `DateOnly` instead of `Date`.	Required if the field is new.	37.0
`format`	String	For dates, the format string is used to parse the input value; for other field types, the format string is used for display.	Optional	37.0
`label`	String	A user-friendly label for the field.	Optional	37.0
`multiValue`	Boolean	Indicates whether the field is a multivalue field (`true`) or not (`false`). The default is `false`.	Optional	37.0
`multiValueSeparator`	String	The value separator, used only if the field is a multivalue field.	Optional	37.0
`name`	String	The field developer name.	Required	37.0
`precision`	Integer	The numeric precision or text length depending on field type.	Optional	37.0
`scale`	Integer	The numeric scale.	Optional	37.0
`skipped`	Boolean	Indicates whether the field should be skipped on replication (`true`) or not (`false`). The default is `false`. If set to `true`, this field is ignored when syncing. The field metadata isn’t deleted, however, so the field can be 'unskipped' and made active later.	Required	37.0
`systemField`	Boolean	Indicates whether the field is a system field (`true`) or not (`false`). The default is false. System fields aren’t queryable.	Optional	37.0
`uniqueId`	Boolean	Indicates whether the field is a unique ID for the data set (`true`) or not (`false`). The default is `false`. There can only be one unique ID for any dataset.	Optional	37.0

# Report Source Asset A contextual representation of a report asset. Properties ReportSourceAsset inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). # Restore Dataset Version The message returned for an Analytics data connector ingest request or an Analytics dataset version update request. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | message | String | The message result of the Analytics connector data sync request or the restore dataset version. | Small, 43.0 | 43.0 | | url | String | The URL to get the status of the request. | Small, 43.0 | 43.0 | #### See Also - [Data Connector Ingest Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_ingest.htm "Triggers the Analytics connector to run a data sync. This API is the equivalent of the “Run Now” UI feature.") - [Dataset Versions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm "Returns a list of dataset versions for a particular dataset or creates a version.") # Restore Dataset Version Input A specific version to restore an Analytics dataset to. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | sourceVersion | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The source version to restore. | Required | 41.0 | #### See Also - [Dataset Versions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions.htm "Returns a list of dataset versions for a particular dataset or creates a version.") - [Dataset Version Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_datasets_id_versions_id.htm "Returns an Analytics dataset version or updates the version predicate.") # Rule Definition Input A rule definition to use for a JSON transformation. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | constants | [ConstantInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_constant_input.htm "The definition of a constant for JSON transformation rules.")\[\] | A list of rule constants. | Optional | 43.0 | | macros | [MacroInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_macro_input.htm "A macro to use for a JSON transformation rule.")\[\] | A list of rule macros. | Optional | 43.0 | | rules | [RuleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_rule_input.htm "A rule for a JSON Transformation rule definition.")\[\] | A list of rules. | Required | 43.0 | # Rule Input A rule for a JSON Transformation rule definition. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | actions | [ActionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_action_input.htm "The action for a rule or macro to perform during a JSON transformation.")\[\] | A list of actions for the rule. | Required | 43.0 | | condition | String | The condition to meet for the action to be run. | Optional | 43.0 | | name | String | The name of the rule. | Required | 43.0 | # Run, Schedule, and Sync CRM Analytics Data with REST APIs You can use the CRM Analytics REST API to automate features, like running and scheduling data syncs, dataflows and recipes. ## Start and Stop a Dataflow Job or Recipe You can use REST APIs to automate the start of a dataflow job or recipe to load data into datasets. This API is the equivalent of the "Run Now" functionality in the Data Manager. You can also stop the job while it’s running. Dataflow jobs include dataflows defined in wave/dataflows and recipes defined in wave/recipes. ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note You can use the Lightning Web Component lightning/analyticsWaveApi module to access wire adapters and functions to bring this functionality into Salesforce, without proxying the REST APIs directly. For more information, see the reference section for [lightning/analyticsWaveApi Wire Adapters and Functions](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_wire_adapters_get_datasets) . - Start a Dataflow Job or Recipe To start a dataflow or recipe, use the [/wave/dataflowjobs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs.htm "Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes.") endpoint with a POST request. In the POST request body, use the dataflowId parameter to specify the dataflow to start. For a recipe, use the targetDataflowId value for the dataflowId. { "dataflowId": "02KS700000004G3eMAE", "command" : "start" } The POST request returns a [Dataflow Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job.htm "An Analytics dataflow job."). ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/images/icon_note.png) #### Note If the sync has not previously run or has been updated since the last run, when you run a dataflow or recipe using this method, the data sync of associated objects runs automatically. - Stop a Dataflow Job or Recipe To stop a specific dataflow job, use the [/wave/dataflowjobs/](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_id.htm "Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes.") endpoint with a PATCH request. The PATCH request uses the dataflowjobId request parameter to specify the dataflow job to stop. { "command" : "stop" } ## Explore Dataflow Job Nodes You can use REST APIs to describe and explore each node of a dataflow job, including nodes for standard dataflows and for recipes. - View All Dataflow Job Nodes To list the nodes for the dataflow job, use the [/wave/dataflowjobs//nodes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes.htm "Returns a collection of dataflow job nodes for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection.") endpoint with a GET request. The GET request returns a [Dataflow Job Node Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_collection.htm "A collection of Analytics dataflow jobs."). Note: This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. If the dataflow job id starts with 030, the result is an empty collection. - View a Single Dataflow Job Node To view the details of a single dataflow job node, use the [/wave/dataflowjobs//nodes/](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataflowjobs_nodes_id.htm "Returns a dataflow job node for a standard dataflow or a recipe. This request only works for dataflow jobs with ids starting with 030, 03C, or 0eP. The node id must start with 03L.") endpoint with a GET request. The GET request returns a [Dataflow Job Node](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataflow_job_node.htm "A node in a dataflow job."). ## Schedule Dataflows, Recipes, and Data Syncs You can automate dataflows, recipes, and data syncs to run on a time-based schedule by hour, week, or month, on specific days of the week, or dates in the month via the CRM Analytics REST API. For example, schedule a dataflow to ensure that the data is available by a particular time or to run the job during non-business hours. Use the assetId request parameter to specify the data asset type to schedule. You can also set an event-based schedule to run a dataflow or recipe after the Salesforce Local connection syncs. Set an event-based schedule if the dataflow or recipe extracts data from Salesforce objects that have to sync before the dataflow or recipe runs. The event-based schedule applies to dataflows and recipes only and isn’t currently available for data syncs. - Schedule a Data Asset To schedule a data asset, use the [/wave/asset//schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm "Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync.") endpoint with a PUT request. The following are examples for the different types of schedules that can be set in the request body. Set Hourly Schedule - request body example This request body sets a time-based schedule that runs hourly every day from 2:30am America/Los Angeles, every 3 hours, and stops queuing at 8:00pm. { "daysOfWeek" : \[ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" \], "lastHour" : 20, "hourlyInterval" : 3, "time" : { "hour" : 2, "minute" : 30, "timeZone" : "America/Los\_Angeles" }, "frequency" : "hourly" } Set Weekly Schedule - request body example This request body sets a time-based schedule that runs weekly on Mondays and Thursdays at 12:45am America/Los Angeles. { "daysOfWeek" : \[ "Monday", "Thursday" \], "time" : { "hour" : 0, "minute" : 45, "timeZone" : "America/Los\_Angeles" }, "frequency" : "weekly" } Set Monthly Specific Schedule - request body example This request body sets a time-based schedule that runs monthly on the 1st, 15th, and 31st at 12:00am America/Los Angeles. { "daysOfMonth" : \[ 1, 31, 15 \], "time" : { "hour" : 0, "minute" : 0, "timeZone" : "America/Los\_Angeles" }, "frequency" : "monthly" } Set Monthly Relative Schedule - request body example This request body sets a time-based schedule that runs every month on the last Sunday at 12:00am America/Los Angeles. { "weekInMonth": "Last", "dayInWeek": "Sunday" "time" : { "hour" : 0, "minute" : 0, "timeZone" : "America/Los\_Angeles" }, "frequency" : "monthlyrelative" } Set Event-Based Schedule - request body example This request body sets an event-based schedule that runs a dataflow after the Salesforce Local connection syncs. Event-based schedules aren’t supported for Data Connections. { "triggerRule" : "$ALL\_SALESFORCE\_OBJECTS", "frequency" : "eventdriven" } The PUT request uses the assetId request parameter to specify the dataflow, recipe, or data sync to schedule. /services/data//wave/asset/02KS7000000xxxxxxx/schedule The PUT response is empty unless there’s an API error. The DELETE request uses the assetId request parameter to specify the dataflow, recipe, or data sync schedule to delete. ## Sync Data Connections Use the CRM Analytics REST API to automate syncing connected data from your local Salesforce org or external data sources. Synced data is stored as objects that can be used in dataflows and recipes. This API is the equivalent of the "Run Now" functionality in the Data Manager. - Data Sync Run Now To start a data sync, use the[/wave/dataConnectors//ingest](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_ingest.htm "Triggers the Analytics connector to run a data sync. This API is the equivalent of the “Run Now” UI feature.") endpoint with a POST request. Execute the POST to the URL with an empty request body. {} The POST request uses the connectorId request parameter to specify the data sync to run. /services/data//wave/dataConnectors/0ItS0000000xxxxxxx/ingest The POST request returns a [Restore Dataset Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_restore_dataset_version.htm "The message returned for an Analytics data connector ingest request or an Analytics dataset version update request."). # SAQL Query Input An Analytics query written in SAQL or SQL. Properties

Property Name	Type	Description	Required or Optional	Available Version
`licenseAttributes`	`LicensesAttributesInput`	The Analytics license type and other properties.	Optional	53.0
`name`	String	The query name.	Optional	41.0
`query`	String	The query string.	Required	40.0
`queryLanguage`	AnalyticsQueryLanguageEnum	The language in which the query in written. The default value is `SAQL`. Valid values are: `SAQL` `SQL`	Required if the query is `SQL`.	48.0
`timezone`	String	The timezone for the query. The org must have timezone enabled for use in queries.	Optional	43.0

#### See Also - [Query Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_query.htm "Executes a query written in Salesforce Analytics Query Language (SAQL) or SQL for CRM Analytics.") - [Query CRM Analytics Data with the Query API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_api_query_data.htm "Use the CRM Analytics REST API to directly query analytics data using SAQL or SQL queries.") # Schedule A schedule on which to execute some type of Analytics asset job. Inherited by [DailySchedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_daily_schedule.htm "Specify a daily schedule for an Analytics asset."), [EmptySchedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_empty_schedule.htm "Specify an empty schedule for an Analytics asset."), [EventDrivenSchedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_event_driven_schedule.htm "Specify an event-driven schedule for an Analytics asset."), [HourlyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_hourly_schedule.htm "Specify an hourly schedule for an Analytics asset."), [MinutelyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_minutely_schedule.htm "Specify a schedule that runs multiple times an hour for an Analytics asset."), [MonthlyRelativeScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_monthly_relative_schedule.htm "Specify a schedule that runs monthly on a relative day within the month for an Analytics asset."), [MonthlySpecificScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_monthly_specific_schedule.htm "Specify a schedule that runs monthly on a specific day within the month for an Analytics asset."), and [WeeklyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_weekly_schedule.htm "Specify a schedule that runs weekly for an Analytics asset.") Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`assetId`	String	The asset ID that this schedule belongs to.	Small, 52.0	52.0
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 39.0	39.0
`nextScheduledDate`	Date	Next scheduled time (in UTC) for this schedule	Small, 43.0	43.0
`notificationLevel`	ConnectEmailNotificationLevelEnum	Email notification level of dataflow associated with this schedule. Valid values are: `Always` `Failures` `Never` `Warnings`	Small, 43.0	43.0
`time`	Time	Hour,minute, and timezone in which this schedule is run	Small 39.0	39.0

#### See Also - [Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm "Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync.") # Schedule Details The base Analytics schedule details, inherited by SubscriptionDailySchedule and SubscriptionWeeklySchedule. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | time | Integer | The time at which this schedule is run. | Small, 47.0 | 47.0 | # Schedule Details Input The base Analytics schedule details. Inherited by [SubscriptionDailyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_daily_schedule_input.htm "The daily schedule on which to execute an Analytics subscription.") and [SubscriptionWeeklyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_weekly_schedule_input.htm "The weekly schedule on which to execute an Analytics subscription."). Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | time | Integer | The time at which this schedule is run. | Required | 47.0 | # Schedule Input A schedule on which to execute some type of Analytics asset. Inherited by [DailyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_daily_schedule_input.htm "Specify a daily schedule for an Analytics asset."), [EventBasedScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_event_based_schedule_input.htm "Specify an event-driven schedule for an Analytics asset."), [HourlyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_hourly_schedule_input.htm "Specify a sub-daily schedule for an Analytics asset."), [MinutelyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_minutely_schedule_input.htm "Specify a sub-hourly schedule for an Analytics asset."), [MonthlyRelativeScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_monthly_relative_schedule_input.htm "Specify a monthly schedule for an Analytics asset where the day are relative to their location in the week."), [MonthlySpecificScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_monthly_specific_schedule_input.htm "Specify a monthly schedule for an Analytics asset where the days are fixed by numerical date."), and [WeeklyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_weekly_schedule_input.htm "Specify a weekly schedule for an Analytics asset."). Properties

Property Name	Type	Description	Required or Optional	Available Version
`notificationLevel`	ConnectEmailNotificationLevelEnum	Valid types of email notification levels you can set. Valid values are: `Always` `Failures` `Never` `Warnings`	Small, 42.0	42.0
`time`	Time Input	Hour,minute, and timezone in which this schedule is run	Required	39.0

The following JSON shows how to create an hourly schedule for an asset. { "daysOfWeek" : \[ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" \], "lastHour" : 20, "hourlyInterval" : 3, "time" : { "hour" : 2, "minute" : 30, "timeZone" : "America/Los\_Angeles" }, "frequency" : "hourly" } #### See Also - [Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_schedule.htm "Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync.") # Schedule Resource Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync. ## Resource URL /wave/asset//schedule ## Formats JSON ## Available Version GET (52.0), PUT (40.0), DELETE (43.0) ## Available in Postman To view and test a working example of this resource, see [getSchedule](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-0eb40a43-21af-47c0-8be5-1e93a6a38772?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getSchedule()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-schedule.html) - LWC — [lightning/analyticsWaveApi updateSchedule()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-schedule.html) ## HTTP Methods GET PUT DELETE ## Response body for GET and PUT [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.") ## Request body for PUT The request body can be one of the following schedule types: [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset."), [HourlyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_hourly_schedule_input.htm "Specify a sub-daily schedule for an Analytics asset."), [WeeklyScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_weekly_schedule_input.htm "Specify a weekly schedule for an Analytics asset."), [MonthlyRelativeScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_monthly_relative_schedule_input.htm "Specify a monthly schedule for an Analytics asset where the day are relative to their location in the week."), [MonthlySpecificScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_monthly_specific_schedule_input.htm "Specify a monthly schedule for an Analytics asset where the days are fixed by numerical date."), or[EventBasedScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_event_based_schedule_input.htm "Specify an event-driven schedule for an Analytics asset.") ## Examples For more examples on about how to schedule dataflows, recipes, and connection syncs, see [Schedule Dataflows, Recipes, and Data Syncs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_run_schedule_sync_data.htm#schedule_data_assets) # Scheduled Item The base schedule for a data refresh. Inherited by [DailyScheduledItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_daily_scheduled_item.htm "The daily schedule for a data refresh.") and [WeeklyScheduledItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_weekly_scheduled_item.htm "The weekly schedule for a data refresh.") Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`frequency`	ConnectScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `Weekly` (Run on one or more days each week)	Small, 57.0	57.0
`nextScheduledRun`	Date	The next scheduled time for this schedule	Small, 57.0	57.0
`time`	ScheduledTime	The scheduled run time.	Small 57.0	57.0

# Scheduled Item Input The base schedule for a data refresh. Inherited by [DailyScheduledItemInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_daily_scheduled_item_input.htm "The daily schedule for a data refresh.") and [WeeklyScheduledItemInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_weekly_scheduled_item_input.htm "The weekly schedule for a data refresh.") Properties

Property Name	Type	Description	Required or Optional	Available Version
`frequency`	ConnectScheduleFrequencyTypeEnum	Frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `Weekly` (Run on one or more days each week)	Required	57.0
`nextScheduledRun`	Date	The next scheduled time for this schedule	Required	57.0
`time`	ScheduledTimeInput	The scheduled run time.	Required	57.0

# Scheduled Time The base schedule for a data refresh. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | hour | Integer | The hour at which this schedule is run (0-23). | Small, 57.0 | 57.0 | | minute | Integer | The minute at which this schedule is run (0-59). | Small, 57.0 | 57.0 | | timeZone | [ScheduledTimeZone](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_scheduled_timezone.htm "The information for a schedule time zone.") | The time zone of the hour at which the schedule is run. | Small, 57.0 | 57.0 | # Scheduled Time Input The base schedule for a data refresh. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | hour | Integer | The hour at which this schedule is run (0-23). | Required | 57.0 | | minute | Integer | The minute at which this schedule is run (0-59). | Required | 57.0 | | timeZone | [ScheduledTimeZoneInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_scheduled_timezone_input.htm "The information for a schedule time zone.") | The time zone of the hour at which the schedule is run. | Required | 57.0 | # Scheduled Timezone The information for a schedule time zone. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | gmtOffset | Double | The signed offset, in hours, from GMT. | Small, 57.0 | 57.0 | | name | String | The display name of this time zone. | Small, 57.0 | 57.0 | | zoneId | String | The id of this time zone. | Small, 57.0 | 57.0 | # Scheduled Timezone Input The information for a schedule time zone. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | gmtOffset | Double | The signed offset, in hours, from GMT. | Required | 57.0 | | name | String | The display name of this time zone. | Required | 57.0 | | zoneId | String | The id of this time zone. | Required | 57.0 | # Security Coverage Dataset Version Resource Returns the security coverage (sharing inheritance) for a particular dataset version. The source objects listed are local to the org (there are no objects from other orgs or other external sources). ## Resource URL /wave/security/coverage/datasets//versions/ ## Formats JSON ## Available Version 41.0 ## Available in Postman To view and test a working example of this resource, see [getDatasetCoverage](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-edb258a5-cc12-4845-af0a-235373e5c076?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getSecurityCoverageDatasetVersion()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-security-coverage-dataset-version.html) ## HTTP Methods GET ## Response body for GET [Dataset Coverage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_coverage.htm "The security coverage for a specific dataset version.") # Security Coverage Object Resource Returns the security coverage for a particular object. Use this API to discover whether Analytics can inherit sharing settings from an object. Resource URL /wave/security/coverage/objects/ Formats JSON Available Version 41.0 HTTP Methods GET Response body for GET [Object Coverage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_object_coverage.htm "The security coverage for a source object.") # Security Predicate The security predicate for an Analytics dataset. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | predicate | String | The security predicate expression. | Small, 59.0 | 59.0 | | predicateVersion | String | The security predicate version. | Small, 59.0 | 59.0 | # Send To Email Notification Action Configuration The notification action configuration for sending an email. Properties SendToEmailNotificationActionConfiguration inherits properties from the abstract [BaseNotificationActionConfiguration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_notification_action_configuration.htm "The base Analytics notification action configuration."). # Send To Email Notification Action Configuration Input The notification action configuration for sending an email. Properties SendToEmailNotificationActionConfigurationInput inherits properties from the abstract [BaseNotificationActionConfigurationInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_notification_action_configuration_input.htm "The base Analytics notification action configuration."). # Set Up Your Postman Collection Set up Postman to work with the Salesforce CRM Analytics Connect API collection. Create your Postman workspace, fork the collection, and authorize your org. ## Create a Postman Workspace Configure the desktop Postman app if you haven’t already done so. 1. Make sure that you previously downloaded and installed the [Postman Desktop App](https://www.postman.com/downloads/ "HTML (New Window)"). 2. Select the **Workspaces** menu. 3. Select **Create Workspace**. 4. Name your workspace, for example, SalesforceCRMACollection. 5. For Visibility, set it to **Personal**. 6. Click **Create Workspace**. ## Fork the Salesforce CRM Analytics API Collection Fork the main collection for your own use. 1. At the top of your Postman Desktop app, click **Search Postman**, click **Teams**, and enter Salesforce Developers in the search bar. 2. Click **Salesforce Developers**, then click the **Salesforce Developers** tile. 3. Hover over the Subscription Management collection, click the three dots, then click **Create a Fork**. 4. Label the fork, choose the workspace, and click **Fork Collection**. Your workspace contains your fork of the CRM Analytics Connect API collection. ## Authorize your Org Authorize your Salesforce Trailhead org for your forked collection. 1. In your Postman workspace, select your forked Salesforce CRM Analytics Connect APIs collection. 2. Select **No Environment.** 3. Click the **Authorization** tab, and select **OAuth 2.0** as the type. 4. At the bottom of the Authorization tab, click **Get New Access Token**. 5. To let the Collection access your Trailhead Playground, click **Allow**. A success message appears briefly, and then you’re redirected to the Manage Access Tokens dialog. 6. Verify that the instance\_url points to your Trailhead Playground. 7. Copy the instance\_url, making sure to copy only the URL with no extra characters. 8. Click **Use Token**. 9. Select the **Variables** tab. 10. In the \_endpoint row, CURRENT VALUE column, paste the instance\_url value that you copied previously. 11. Set the Salesforce API version number in the version row, CURRENT VALUE column. 12. Enter the URL that you run each request against in the baseURL row, CURRENT VALUE column. 13. Save your work. # Sharing Inheritance The sharing inheritance for an Analytics dataset. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | sharingEnabled | Boolean | Indicates whether sharing is enabled for the dataset version (true) or not (false). | Small, 59.0 | 59.0 | | sharingSource | String | The name of object from which this dataset version inherits sharing rules. | Small, 59.0 | 59.0 | # Single Column Layout A single column layout for an Analytics template wizard page. Properties Inherits properties from [Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_layout.htm "The base layout for an Analytics template wizard page."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | center | [Panel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel.htm "A panel in a column layout for an Analytics template wizard page.") | The center and only panel in the single column layout. | Small, 56.0 | 56.0 | # Size Limit The size limit of an Analytics template array type variable. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | max | Integer | The maximum number of elements in the array. | Small, 37.0 | 37.0 | | min | Integer | The minimum number of elements in the array. | Small, 37.0 | 37.0 | # Slack Reference The reference for a Slack entity. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | platformId | String | The Slack platform ID. | Small, 53.0 | 53.0 | # Slack Reference Input The reference for a Slack entity. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | platformId | String | The Slack platform ID. | Required | 53.0 | # Snapshot An Analytics snapshot. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | actions | [NotificationAction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_notification_actions.htm "A notification action for an Analytics subscription.")\[\] | The list of actions taken when the subscription is executed. | Small, 53.0 | 53.0 | | active | Boolean | Indicates whether the subscription is active (true) or not (false). | Small, 47.0 | 47.0 | | assetBundle | [WaveAssetBundle](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_asset_bundle.htm "The Analytics asset bundled with the associated metadata.") | The asset bundle associated with the subscription. | Small, 47.0 | 47.0 | | createdDate | Date | The date the subscription was created. | Small, 47.0 | 47.0 | | id | String | The ID of the subscription. | Small, 47.0 | 47.0 | | lastModifiedDate | Date | The date the subscription was last modified on. | Small, 47.0 | 47.0 | | schedule | [SubscriptionSchedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_schedule.htm "An Analytics subscription schedule.") | The schedule for the subscription notifications. | Small, 47.0 | 47.0 | # Sobject Field Type The sobject field type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataType | String | The sobject field data type when a default field isn't supplied. | Small, 36.0 | 36.0 | # Sobject Type The sobject type of an Analytics template variable. ## Properties Inherits properties from [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."). # Source Details Input The abstract source details for a subscription. Inherited by [CollectionSubscriptionSourceDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_collection_subscription_source_input.htm "The collection subscription source."), [DashboardSubscriptionSourceDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_subscription_source_input.htm "The dashboard subscription source."), and [WidgetSubscriptionSourceDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_widget_subscription_source_input.htm "The widget subscription source."). # Source Field A field for a source object. Properties SourceField inherits properties from the abstract [AbstractField](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_abstract_field.htm "The base definition of a dataset field."). These base properties appear in SourceField alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accessDeniedReason | String | If this source field is inaccessible, this property contains a message describing the reason. | Small, 37.0 | 37.0 | | accessible | Boolean | If this property is present and false, the source field is inaccessible and can’t be synced. Check the accessDeniedReason property for more information. | Small, 37.0 | 37.0 | # Source Field Collection A collection of fields for a source object. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataConnector | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | A reference to the data connector that the fields belong to. | Small, 53.0 | 53.0 | | fields | [SourceField](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_field.htm "A field for a source object.")\[\] | A list of Source Fields. | Small, 37.0 | 37.0 | | sourceObjectName | String | The name of the source object that the fields belong to. | Small, 53.0 | 53.0 | | url | String | URL to get the collection. | Small, 37.0 | 37.0 | #### See Also - [Data Connector Source Object Fields Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connector_sourceobject_fields.htm "Returns a list of source fields for a particular source object.") # Source Object A source object for an Analytics data connector. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accessDeniedReason | String | If this source object is inaccessible, this property contains a message describing the reason. | Small, 37.0 | 37.0 | | accessible | Boolean | If this property is present and false, the source object is inaccessible and can’t be synced. Check the accessDeniedReason property for more information. | Small, 37.0 | 37.0 | | connectorLabel | String | The label of this source object. The specifics depend on the connector type. | Small, 53.0 | 53.0 | | dataConnector | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | A reference to the data connector that the source object belongs to. | Small, 53.0 | 53.0 | | dataPreviewUrl | String | The URL to retrieve the data preview associated with this source object. | Small, 40.0 | 40.0 | | dataUrl | String | The URL to get the data associated with this source object. | Small, 39.0 | 39.0–39.0 | | fieldsUrl | String | The URL to get the list of source fields that this source object has. | Small, 37.0 | 37.0 | | name | String | The external name of this source object. The specifics depend on the connector type. | Small, 37.0 | 37.0 | | replicated | Boolean | Indicates whether this source object is synced in Analytics (true) or not (false). | Small, 37.0 | 37.0 | | url | String | The URL to get this source object. | Small, 37.0 | 37.0 | #### See Also - [Data Connector Source Object Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_sourceobjects_sourceobjectname.htm "Returns a source object resource for an Analytics connector. A source object represents a specific category or type of data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets.") # Source Object Collection A collection of source objects for an Analytics data connector. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | nextPageUrl | String | The URL to get the next page of source objects in the collection. | Small, 53.0 | 53.0 | | sourceObjects | [SourceObject](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_source_object.htm "A source object for an Analytics data connector.")\[\] | A list of source objects. | Small, 37.0 | 37.0 | | totalSize | Integer | The total count of elements in the collection, irrespective of the page. | Small, 53.0 | 53.0 | | url | String | The URL to get the collection. | Small, 53.0 | 53.0 | #### See Also - [Data Connector Source Objects List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connectorid_sourceobjects.htm "Returns a list of all the source objects that are present under the specified Analytics connection.") # Source Object Data The data retrieved from a source object given a list of fields and advanced properties. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataListJson | String | The JSON representation, as a string, for data preview to show. | Small, 39.0 | 39.0 | | url | String | The URL to get this Source Object Data. | Small, 39.0 | 39.0 | #### See Also - [Data Connector Source Object Data Preview Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connector_sourceobject_datapreview.htm "Returns a preview of the source object data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets.") # Source Object Data Input The request to retrieve data from a source object given a list of fields and advanced properties. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | sourceObjectFields | Object\[\] | A list of fields used to filter the results returned in the response. | Required | 40.0 | | advancedProperties | Object([AdvancedPropertyValueInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_advanced_property_value_input.htm "An advanced property name and value pair.")) | A list of user-specified advanced properties associated with this source object. | Optional | 40.0 | #### See Also - [Data Connector Source Object Data Preview Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dataconnectors_connector_sourceobject_datapreview.htm "Returns a preview of the source object data that the Analytics connector knows about. When a source object is synced to Analytics, it can be used to create datasets.") # String Type The string type of an Analytics template variable. ## Properties Inherits properties from [VariableType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm "The abstract type for an Analytics template variable."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | String\[\] | The restricted list of enumerated string values. | Small, 36.0 | 36.0 | | enumsLabels | String\[\] | The optional list of display labels for the enumerated values. | Small, 58.0 | 58.0 | # Subscription An Analytics subscription. Properties Subscription inherits properties from the abstract [Snapshot](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_snapshot.htm "An Analytics snapshot."). These base properties appear in Subscription alongside the properties defined explicitly in the following table. | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | source | [SubscriptionSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_source.htm "The base Analytics subscription source.") | The subscription source including type, label, and record ID. | Small, 52.0 | 52.0 | #### See Also - [Subscriptions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions.htm "Returns a list of subscriptions or creates a subscription schedule.") - [Subscription Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid.htm "Retrieve, update, or delete a subscription.") - [Subscription Layout Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_layout.htm "Update the grid layout for a subscription.") - [Subscription Widgets Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets.htm "Create a subscription for a widget.") - [Subscription Widget Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets_id.htm "Update or delete a subscription for a widget.") # Subscription Collection A collection of Analytics subscriptions. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | subscriptions | [Subscription](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription.htm "An Analytics subscription.")\[\] | A collection of subscriptions. | Small, 47.0 | 47.0 | #### See Also - [Subscriptions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions.htm "Returns a list of subscriptions or creates a subscription schedule.") # Subscription Daily Schedule The daily schedule on which to execute an Analytics subscription. Properties SubscriptionDailySchedule inherits properties from the abstract [ScheduleDetails](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule_details.htm "The base Analytics schedule details, inherited by SubscriptionDailySchedule and SubscriptionWeeklySchedule."). # Subscription Daily Schedule Input The daily schedule on which to execute an Analytics subscription. Properties SubscriptionDailyScheduleInput inherits properties from the abstract [ScheduleDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_details_input.htm "The base Analytics schedule details."). # Subscription Input An Analytics subscription. Properties SubscriptionInput inherits properties from the abstract [BaseSubscriptionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_subscription_input.htm "The base subscription request input."). These base properties appear in SubscriptionInput alongside the properties defined explicitly in the following table. | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | schedule | [SubscriptionScheduleInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_schedule_input.htm "An Analytics subscription input.") | The subscription schedule. | Required | 47.0 | | source | [SubscriptionSourceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_source_input.htm "The subscription source.") | The subscription source including type, label, and record ID. | Small, 52.0 | 52.0 | #### See Also - [Subscriptions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions.htm "Returns a list of subscriptions or creates a subscription schedule.") - [Subscription Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid.htm "Retrieve, update, or delete a subscription.") # Subscription Layout Resource Update the grid layout for a subscription. Resource URL /wave/subscriptions/layout Formats JSON Available Version 47.0 HTTP Methods PATCH Request parameters for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | subscriptionId | Id | The ID of the subscription. | Required | 51.0 | PATCH Request Body | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | gridLayout | [GridLayoutInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboard_state_input_rep.htm#GridLayoutInputRepresentation) | The update to the grid layout for the subscription. | Required | 47.0 | Response body for PATCH [Subscription](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription.htm "An Analytics subscription.") # Subscription Resource Retrieve, update, or delete a subscription. Resource URL /wave/subscriptions/ Formats JSON Available Version 47.0 HTTP Methods GET DELETE PATCH Request parameters for GET, PATCH, and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | subscriptionId | Id | The ID of the subscription. | Required | 47.0 | Response body for GET and PATCH [Subscription](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription.htm "An Analytics subscription.") PATCH Request Body | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | runNow | Boolean | Indicates whether the subscription should run now (true) or later (false). | Required | 47.0 | | subscription | [SubscriptionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_input.htm "An Analytics subscription.") | The subscription details to update. | Required | 47.0 | # Subscription Resources Manages subscriptions for Analytics dashboards. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Subscriptions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions.htm "Returns a list of subscriptions or creates a subscription schedule.") | Returns a list of subscriptions or creates a subscription schedule. | GET POST | /wave/subscriptions | | [Subscription Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid.htm "Retrieve, update, or delete a subscription.") | Retrieve, update, or delete a subscription. | GET PATCH DELETE | /wave/subscriptions/ | | [Subscription Layout Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_layout.htm "Update the grid layout for a subscription.") | Update the grid layout for a subscription. | PATCH | /wave/subscriptions//layout | | [Subscription Widgets Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets.htm "Create a subscription for a widget.") | Create a subscription for a widget. | POST | /wave/subscriptions//widgets | | [Subscription Widget Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets_id.htm "Update or delete a subscription for a widget.") | Update or delete a subscription for a widget. | PATCH DELETE | /wave/subscriptions//widgets/ | - **[Subscriptions List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions.htm)** Returns a list of subscriptions or creates a subscription schedule. - **[Subscription Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid.htm)** Retrieve, update, or delete a subscription. - **[Subscription Layout Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_layout.htm)** Update the grid layout for a subscription. - **[Subscription Widgets Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets.htm)** Create a subscription for a widget. - **[Subscription Widget Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets_id.htm)** Update or delete a subscription for a widget. # Subscription Schedule An Analytics subscription schedule. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`details`	ScheduleDetails	The schedule details, including time and frequency details. Valid values are: SubscriptionDailySchedule SubscriptionWeeklySchedule	Small, 47.0	47.0
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	The frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Small, 47.0	47.0

# Subscription Schedule Input An Analytics subscription input. Properties

Parameter Name	Type	Description	Required or Optional	Available Version
`details`	ScheduleDetailsInput	The schedule details, including time and frequency details. Valid values are: SubscriptionDailyScheduleInput SubscriptionWeeklyScheduleInput	Required	47.0
`frequency`	ConnectWaveScheduleFrequencyTypeEnum	The frequency on which this schedule is run. Valid values are: `Daily` (Run once per day) `EventDriven` (Create Event Driven schedule) `Hourly` (Run on one or more hours each day) `Minutely` (Run subhourly each day) `Monthly` (Run on one or more specific numeric days per month) `MonthlyRelative` (Run on one or more relative days for month) `None` (Not scheduled to run) `Weekly` (Run on one or more days each week)	Required	47.0

# Subscription Source The base Analytics subscription source. Properties Inherited by [CollectionSubscriptionSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_collection_subscription_source.htm "The collection subscription source."), [DashboardSubscriptionSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_subscription_source.htm "The dashboard subscription source."), and [WidgetSubscriptionSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_widget_subscription_source.htm "The widget subscription source.").

Parameter Name	Type	Description	Filter Group and Version	Available Version
`type`	ConnectSubscriptionSourceTypeEnum	The source type for the subscription. Valid values are: `Collection` `Dashboard` `Widget`	Required	52.0

# Subscription Source Input The subscription source. Properties

Parameter Name	Type	Description	Required or Optional	Available Version
`details`	SourceDetailsInput	The source details. Valid values are: CollectionSubscriptionSourceInput DashboardSubscriptionSourceInput WidgetSubscriptionSourceInput	Required	52.0
`type`	ConnectSubscriptionSourceTypeEnum	The source type for the subscription. Valid values are: `Collection` `Dashboard` `Widget`	Required	52.0

# Subscription Weekly Schedule The weekly schedule on which to execute an Analytics subscription. Properties SubscriptionWeeklySchedule inherits properties from the abstract [ScheduleDetails](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule_details.htm "The base Analytics schedule details, inherited by SubscriptionDailySchedule and SubscriptionWeeklySchedule."). These base properties appear in SubscriptionWeeklySchedule alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	SubscriptionScheduleDayOfWeek	The days of the week for schedule frequency. Valid values are: `Fri` `Mon` `Sat` `Sun` `Thu` `Tue` `Wed`	Small, 47.0	47.0

# Subscription Weekly Schedule Input The weekly schedule on which to execute an Analytics subscription. Properties SubscriptionWeeklyScheduleInput inherits properties from the abstract [ScheduleDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_details_input.htm "The base Analytics schedule details."). These base properties appear in SubscriptionWeeklyScheduleInput alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	SubscriptionScheduleDayOfWeek	The days of the week for schedule frequency. Valid values are: `Fri` `Mon` `Sat` `Sun` `Thu` `Tue` `Wed`	Small, 47.0	47.0

# Subscription Widget Input An Analytics widget subscription inherits properties from the base Dashboard Widget Item Input. #### See Also - [Subscription Widgets Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets.htm "Create a subscription for a widget.") - [Subscription Widget Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_subscriptions_subscriptionid_widgets_id.htm "Update or delete a subscription for a widget.") # Subscription Widget Resource Update or delete a subscription for a widget. Resource URL /wave/subscriptions//widgets/ Formats JSON Available Version 47.0 HTTP Methods DELETE PATCH Request parameters for PATCH and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | subscriptionId | Id | The ID of the subscription. | Required | 47.0 | | widgetId | Id | The ID of the widget. | Required | 47.0 | Request body for PATCH [Subscription Widget Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_widget_input.htm "An Analytics widget subscription inherits properties from the base Dashboard Widget Item Input.") Response body for PATCH [Subscription](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription.htm "An Analytics subscription.") # Subscription Widgets Resource Create a subscription for a widget. Resource URL /wave/subscriptions//widgets Formats JSON Available Version 47.0 HTTP Methods POST Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | subscriptionId | Id | The ID of the subscription. | Required | 51.0 | Request body for POST [Subscription Widget Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_widget_input.htm "An Analytics widget subscription inherits properties from the base Dashboard Widget Item Input.") Response body for POST [Subscription](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription.htm "An Analytics subscription.") # Subscriptions List Resource Returns a list of subscriptions or creates a subscription schedule. Resource URL /wave/subscriptions Formats JSON Available Version 47.0 HTTP Methods GET POST Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`type`	`ConnectSubscriptionSourceTypeEnum`	Filters the collection by the subscription source type. Valid values are: `Collection` `Dashboard` `Widget`	Optional	47.0

Response body for GET [Subscription Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_collection.htm "A collection of Analytics subscriptions.") Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | runNow | Boolean | Indicates whether to run the subscription schedule now (true) or not (false). | Required | 47.0 | | subscription | [Subscription Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_subscription_input.htm "An Analytics subscription.") | The subscription schedule to create | Required | 47.0 | Response body for POST [Subscription](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription.htm "An Analytics subscription.") # Template An Analytics template. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`assetIcon`	String	The icon that best represents the Analytics application.	Small, 36.0	36.0–41.0
`assetVersion`	Double	The asset version (API version) of all the dashboards and lenses.	Big, 37.0	37.0
`configurationUrl`	String	The URL to the configuration of the template.	Small, 36.0	36.0
`createdBy`	WaveUser	The user that created the template.	Small, 52.0	52.0
`createdDate`	Date	The date and time the template was created.	Small, 52.0	52.0
`customAttributes`	TemplateCustomAttributes	The custom attribute definitions of the template.	Big, 44.0	44.0
`description`	String	The description of the template.	Big, 36.0	36.0
`folderSource`	AssetReference	The folder source of the template	Medium, 39.0	39.0
`icons`	TemplateIcons	The icons configured for the template.	Small, 41.0	41.0
`id`	String	The ID or fully qualified API name of the template.	Small, 36.0	36.0
`label`	String	The localized name of the application template.	Small, 36.0	36.0
`lastModifiedBy`	WaveUser	The user that last updated the template.	Small, 52.0	52.0
`lastModifiedDate`	Date	The last date and time the template was modified.	Small, 52.0	52.0
`name`	String	The local API name of the template.	Medium, 36.0	36.0
`namespace`	String	The namespace of the template provider.	Medium, 36.0	36.0
`releaseInfo`	TemplateRelease	The release information for the template	Medium, 37.0	37.0
`tags`	String[]	A list of tag definitions for the template.	Big, 44.0	44.0
`templateIcon`	String	The icon that best represents the Analytics application template.	Small, 36.0	36.0–41.0
`templateType`	ConnectWaveTemplateTypeEnum	The type of template. Valid values are: `App` `Dashboard` `Data` `Embedded` `Lens`	Small, 36.0	36.0
`url`	String	The URL to the detail of the template.	Small, 36.0	36.0
`videos`	VideoInfo	The videos associated with the template.	Big, 46.0	46.0

#### See Also - [Templates List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates.htm "Returns a list of Analytics templates, or creates a template.") - [Template Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id.htm "Returns, deletes, or updates an Analytics template.") # Template Collection A collection of Analytics templates. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | templates | [Template](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template.htm "An Analytics template.")\[\] | A list of templates. | Small, 36.0 | 36.0 | #### See Also - [Templates List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates.htm "Returns a list of Analytics templates, or creates a template.") # Template Configuration The configuration for an Analytics Template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID or fully qualified name of the template. | Small, 55.0 | 55.0 | | layout | [UILayoutDefinition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_ui_layout_definition.htm "The UI layout definition for an Analytics template.") | The user interface layout definition for the template. | Small, 56.0 | 56.0 | | name | String | The local API name of the template. | Small, 55.0 | 55.0 | | namespace | String | The namespace of the template provider. | Small, 55.0 | 55.0 | | ui | [UIDefinition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_ui_definition.htm "The UI definition for an Analytics template.") | The user interface definition for the template. | Small, 36.0 | 36.0 | | variables | Map | A map of the defined variables for the template. | Small, 36.0 | 36.0 | The following JSON is an 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, "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": { " 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": \[\], "label": "Please enter your email address?", "required": false, "variableType": { "enums": \[\], "type": "StringType" } } } } #### See Also - [Template Configuration Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_configuration.htm "Returns the configuration of an Analytics template.") # Template Configuration Resource Returns the configuration of an Analytics template. ## Resource URL /wave/templates//configuration ## Formats JSON ## Available Components - Apex — [Wave.Templates.getTemplateConfig()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_apex_templates.htm) - Aura — [ getTemplateConfig()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - LWC — [lightning/analyticsWaveApi getWaveTemplateConfig()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-template-config.html) ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getWaveTemplateConfig](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-0cd841b5-9805-409d-8d26-bfd5d7747d3b?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## HTTP Methods GET ## Request Parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`disableApex`	Boolean	Indicates whether apex integration hooks are disabled (`true`) or not (`false`).	Optional	36.0
`options`	ConnectWaveTemplateVisibilityOptionsEnum	Filter the template configuration by specifying a visibility option. Valid values are: `CreateApp` `ManageableOnly` `OrgCanViewOnly` `ViewOnly`	Optional	57.0
`templateIdOrApiName`	String	The ID of template to retrieve or delete the lint value for.	Required	36.0

## Response body for GET [Template Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_configuration.htm "The configuration for an Analytics Template.") # Template Custom Attributes The custom attributes or metadata for an Analytics template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The label for the custom attribute metadata. | Small, 44.0 | 44.0 | | values | String\[\] | The list of values for the custom attribute metadata. | Small, 44.0 | 44.0 | # Template Icons The icons for an Analytics template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | appBadge | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The badge icon used on any app created from this template. | Small, 41.0 | 41.0 | | templateBadge | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The badge icon used to represent this template in the template configuration wizard. | Small, 41.0 | 41.0 | | templatePreviews | [ImageAssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_image_asset_reference.htm "A image asset for Analytics.")\[\] | The list of images to display in the carousel on the template detail page when the template is selected in the wizard. | Small, 44.0 | 44.0 | # Template Input An Analytics template. Properties TemplateInput inherits properties from the abstract [BaseAssetInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_asset_input.htm "The base Analytics asset input."). These base properties appear in TemplateInput alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assetVersion | Double | The asset version to set for this template. Only used on template update. | Optional | 54.0 | | dataTransformIds | String\[\] | A list of data transform IDs to include in the template. Data transforms bring data from Data 360 into Analytics. | Optional | 59.0 | | dataflow | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The dataflow associated with this app. | Optional | 39.0 | | folderSource | [AssetReferenceInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_asset_reference_input.htm "An Analytics asset reference.") | The folder that this template is created from. | Required | 39.0 | | recipeIds | String\[\] | A list of recipe IDs to include in the template. Recipes with datasets are automatically included using the dataset to folder connection. This list is for recipes without datasets. | Optional | 55.0 | #### See Also - [Templates List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates.htm "Returns a list of Analytics templates, or creates a template.") - [Template Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id.htm "Returns, deletes, or updates an Analytics template.") # Template Lint The lint score for an Analytics template. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The template name | Small, 58.0 | 58.0 | | score | Double | The lint score for the template, up to 100. | Small, 58.0 | 58.0 | | tasks | [TemplateLintItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_lint_item.htm "An individual linting task for an Analytics template.")\[\] | A list of individual validation task for the template. | Small, 58.0 | 58.0 | #### See Also - [Template Lint Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_lint.htm "Returns, deletes, or creates the lint value for an Analytics template.") # Template Lint Item An individual linting task for an Analytics template. TemplateLintItem inherits properties from the abstract [AbstractLintItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_abstract_lint_item.htm "The base readiness task for an Analytics template."). These base properties appear in TemplateLintItem alongside the properties defined explicitly in the following table. # Template Lint Resource Returns, deletes, or creates the lint value for an Analytics template. ## Resource URL /wave/templates//lint ## Formats JSON ## Available Version 58.0 ## HTTP Methods DELETE GET PUT ## Request parameters for GET, DELETE, and PUT | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | templateIdOrApiName | String | The ID of template to retrieve or delete the lint value for. | Required | 58.0 | ## Response body for GET and PUT [Template Lint](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_lint.htm "The lint score for an Analytics template.") # Template Options The template options used on the last action performed on a templated Analytics app. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`appAction`	ConnectWaveTemplateAppActionEnum	The last template action performed on the templated application. Valid values are: `AutoUpgrade` `Create` `DecoupleApp` `Overlay` `RefreshData` `Upgrade`	Medium, 37.0	37.0
`appActionDate`	Date	The date and time the last action was performed.	Medium, 37.0	37.0
`appActionUser`	WaveUser	The user that performed the last action.	Medium, 37.0	37.0
`dynamicOptions`	Map<String, Object>	A map of dynamic template options that can change from release to release.	Medium, 54.0	54.0

# Template Options Input The template options used to upgrade a templated Analytics app. Properties

Property Name	Type	Description	Required or Optional	Available Version
`appAction`	ConnectWaveTemplateAppActionEnum	The upgrade action to perform on the templated application. Valid values are: `AutoUpgrade` `Create` `DecoupleApp` `Overlay` `RefreshData` `Upgrade`	Required	37.0
`disableApex`	Boolean	Indicates whether any Apex integration hooks should be disabled (`true`) or not (`false`).	Optional	37.0
`dynamicOptions`	Map<String, Object>	A map of dynamic and beta options for app creation or upgrade. Valid values are: `productionType`: valid values include `ATF_3_0` `Classic` `runtimeLogEntryLevel`: valid values include `Fine` `Finer` `Finest` `Info` `Severe` `Warning`	Optional	54.0

# Template Readiness Item An individual validation task for an Analytics template. TemplateReadinessItem inherits properties from the abstract [AbstractLintItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_abstract_lint_item.htm "The base readiness task for an Analytics template."). These base properties appear in TemplateReadinessItem alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | image | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.") | The icon associated with the validation task. | Small, 58.0 | 58.0 | | tags | String\[\] | A list of tags describing the purpose of the validation. | Small, 58.0 | 58.0 | | type | String | A task specific type, associated with the readiness check type. | Small, 58.0 | 58.0 | # Template Release The release information for an Analytics template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | notesUrl | String | The URL to the release notes for this template | Small, 37.0 | 37.0 | | templateVersion | String | The version of this template. | Small, 37.0 | 37.0 | # Template Release Notes The release notes for an Analytics template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID or fully qualified name of the template. | Small, 55.0 | 55.0 | | name | String | The local API name of the template. | Small, 55.0 | 55.0 | | namespace | String | The namespace of the template provider. | Small, 55.0 | 55.0 | | notes | String | The release note's markdown. | Small, 37.0 | 37.0 | #### See Also - [Template Release Notes Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id_releasenotes.htm "Returns the release notes for a single Analytics Template.") # Template Release Notes Resource Returns the release notes for a single Analytics Template. ## Resource URL /wave/templates//releasenotes ## Formats JSON ## Available Version 37.0 ## Available in Postman To view and test a working example of this resource, see [getWaveTemplatesReleaseNotes](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-c613009e-9329-4af9-85ca-dc1885803d2e?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - LWC — [lightning/analyticsWaveApi getWaveTemplateReleaseNotes()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-template-release-notes.html) ## HTTP Methods GET ## Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | templateIdOrApiName | String | The ID of template to retrieve or delete the lint value for. | Required | 37.0 | ## Response body for GET [Template Release Notes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_release_notes.htm "The release notes for an Analytics template.") # Template Resource Returns, deletes, or updates an Analytics template. ## Resource URL /wave/templates/ ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getWaveTemplate](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-07461a86-f7a7-4861-9e1d-81493fcb972d?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Apex — [Wave.Templates.getTemplate()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_apex_templates.htm) - Aura — [ getTemplate()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - LWC — [lightning/analyticsWaveApi getWaveTemplate()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-template.html) ## HTTP Methods DELETE GET PUT ## Request parameters for GET, DELETE, and PUT

Parameter Name	Type	Description	Required or Optional	Available Version
`options`	ConnectWaveTemplateVisibilityOptionsEnum	The template visibility options. Valid values are: `CreateApp` `ManageableOnly` `OrgCanViewOnly` `ViewOnly`	Optional	47.0
`templateIdOrApiName`	String	The ID of template to retrieve or delete the lint value for.	Required	36.0

## Response body for GET and PUT [Template](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template.htm "An Analytics template.") ## Request body for PUT [Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_input.htm "An Analytics template.") # Template Resources Manage Analytics templates, template configuration, and template release notes. ## Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Templates List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates.htm "Returns a list of Analytics templates, or creates a template.") | Returns a collection of Analytics templates, or creates a template. | GET POST | /wave/templates | | [Template Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id.htm "Returns, deletes, or updates an Analytics template.") | Returns, deletes, or updates an Analytics template. | GET PATCH DELETE | /wave/templates/ | | [Template Configuration Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_configuration.htm "Returns the configuration of an Analytics template.") | Returns the configuration of an Analytics template. | GET | /wave/templates//configuration | | [Template Lint Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_lint.htm "Returns, deletes, or creates the lint value for an Analytics template.") | Returns the lint value of an Analytics template. | GET DELETE PUT | /wave/templates//lint | | [Template Release Notes Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id_releasenotes.htm "Returns the release notes for a single Analytics Template.") | Resource for retrieving the release notes for a single Analytics Template. | GET | /wave/templates//releasenotes | | [Template Validate Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_validate.htm "Validates an Analytics template for org readiness.") | Performs an org readiness check on an Analytics template. | POST | /wave/templates//validate | - **[Templates List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates.htm)** Returns a list of Analytics templates, or creates a template. - **[Template Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id.htm)** Returns, deletes, or updates an Analytics template. - **[Template Configuration Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_configuration.htm)** Returns the configuration of an Analytics template. - **[Template Lint Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_lint.htm)** Returns, deletes, or creates the lint value for an Analytics template. - **[Template Release Notes Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_id_releasenotes.htm)** Returns the release notes for a single Analytics Template. - **[Template Validation Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_validate.htm)** Validates an Analytics template for org readiness. # Template Validate The validation for an Analytics template. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID or qualified name of the template. | Small, 58.0 | 58.0 | | state | Map | A map of the context values containing the result from the validate call. | Small, 60.0 | 60.0 | | tasks | [TemplateReadinessItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_readiness_item.htm "An individual validation task for an Analytics template.")\[\] | A list of the individual validation tasks for the template. | Small, 58.0 | 58.0 | #### See Also - [Template Validate Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_validate.htm "Validates an Analytics template for org readiness.") # Template Validate Input The input to validate an Analytics template. ## Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | values | Map | A map of runtime template values to use during validation. These values override any default values. | Optional | 58.0 | #### See Also - [Template Validate Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_templates_validate.htm "Validates an Analytics template for org readiness.") # Template Validation Resource Validates an Analytics template for org readiness. ## Resource URL /wave/templates//validate ## Formats JSON ## Available Version 58.0 ## Available Components - LWC — [lightning/analyticsWaveApi validateWaveTemplate()](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/reference_analytics_validate_wave_template) ## HTTP Methods POST ## Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | templateIdOrApiName | String | The ID of template to run org readiness validation for. | Required | 58.0 | ## Request body for POST [Template Validate Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_validate_input.htm "The input to validate an Analytics template.") ## Response body for POST [Template Validate](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_validate.htm "The validation for an Analytics template.") # Templates List Resource Returns a list of Analytics templates, or creates a template. ## Resource URL /wave/templates ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getWaveTemplateCollection](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-9a17328a-39fd-4a3f-95bf-7981dee25419?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## Available Components - Apex — [Wave.Templates.getTemplates()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_apex_templates.htm) - Aura — [ listTemplates()](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_sdk.meta/bi_dev_guide_sdk/bi_sdk_template.htm) - LWC — [lightning/analyticsWaveApi getWaveTemplates()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-wave-templates.html) ## HTTP Methods GET POST ## GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`options`	ConnectWaveTemplateVisibilityOptionsEnum	The template visibility option. Valid values are: `CreateApp` `ManageableOnly` `OrgCanViewOnly` `ViewOnly`	Optional	52.0
`type`	ConnectWaveTemplateTypeEnum	The template type. Valid values are: `App` `Dashboard` `Data` `Embedded` `Lens`	Optional	36.0

## Response body for GET [Template Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template_collection.htm "A collection of Analytics templates.") ## Request body for POST [Template Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_input.htm "An Analytics template.") ## Response body for POST [Template](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_template.htm "An Analytics template.") # Text Item A text item on a panel for an Analytics template wizard page. ## Properties Inherits properties from [Panel Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm "An item on a panel in a column layout for an Analytics template wizard page."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | text | String | The text of the item. | Small, 56.0 | 56.0 | | variant | String | The optional text variant. The valid values are: SubHeader. | Small, 59.0 | 59.0 | # Time The time at which something should happen, usually in relation to an Analytics schedule. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | hour | Integer | Hour at which this schedule is run (0-23). | Small, 39.0 | 39.0 | | minute | Integer | Minute at which this schedule is run (0-59). | Small, 39.0 | 39.0 | | timeZone | [TimeZone](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_time_zone.htm "The time zone in which something should happen, usually in relation to an Analytics schedule.") | Time zone of the hour at which the schedule is run. | Small, 39.0 | 39.0 | # Time Input The time at which something should happen, usually in relation to an Analytics schedule. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | hour | Integer | First hour in the day on which the schedule is run. | Required | 39.0 | | minute | Integer | Minute offset from hour on which the schedule is first run. | Required | 39.0 | | timeZone | String | The time zone the schedule is stored in, which by default, is the user's time zone. | Required | 39.0 | # Time Zone The time zone in which something should happen, usually in relation to an Analytics schedule. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | gmtOffset | Double | The signed offset, in hours, from GMT. | Small, 39.0 | 39.0 | | name | String | The display name of this time zone. | Small, 39.0 | 39.0 | | zoneId | String | The id of this time zone. | Small, 39.0 | 39.0 | # Trended Report An Analytics trended report. Properties

Parameter Name	Type	Description	Filter Group and Version	Available Version
`apexHooksClass`	AssetReference	The reference to the apex class which is used for post processing each time the report is trended.	Small, 37.0	38.0
`dashboard`	AssetReference	The reference to the dashboard for the trended report.	Small, 37.0	37.0
`dataset`	AssetReference	The reference to the dataset with the trended report data.	Small, 37.0	37.0
`id`	String	The 18 character ID of the trended report.	Small, 37.0	37.0
`report`	AssetReference	The reference to the report that is being trended.	Small, 37.0	37.0
`schedule`	Schedule	The schedule on which the trending report should be run. Valid values are: DailySchedule EmptySchedule EventDrivenSchedule HourlySchedule MinutelySchedule MonthlyRelativeSchedule MonthlySpecificSchedule WeeklySchedule	Small, 39.0	39.0
`url`	String	The URL for the trended report.	Small, 37.0	37.0

Parameter Name	Type	Description	Required or Optional	Available Version
`apexHooksClass`	AssetReferenceInput	The reference to the apex class to execute after successful trending.	Optional	38.0
`dashboardLabel`	String	The label for the Analytics dashboard that will be created.	Required	37.0
`datasetLabel`	String	The reference to the dataset used for the report.	Required	37.0
`report`	AssetReferenceInput	The reference to the report being trended.	Required	37.0
`schedule`	ScheduleInput	The schedule on which the trending report should be run. Valid values are: DailyScheduleInput EventBasedScheduleInput HourlyScheduleInput MinutelyScheduleInput MonthlyRelativeScheduleInput MonthlySpecificScheduleInput WeeklyScheduleInput	Optional	39.0

#### See Also - [Trended Reports List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedreports.htm "Returns a list of trending reports or creates a trending report.") - [Trended Report Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedtreports_id.htm "Returns, deletes, or updates a trending report.") # Trended Report Resources Manage Analytics trending reports. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Trended Reports List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedreports.htm "Returns a list of trending reports or creates a trending report.") | Returns or adds to a collection of trending reports. | GET POST | /wave/trendedreports | | [Trended Report Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedtreports_id.htm "Returns, deletes, or updates a trending report.") | Returns, deletes, or updates a trending report. | DELETE GET PATCH | /wave/trendedreports/ | - **[Trended Reports List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedreports.htm)** Returns a list of trending reports or creates a trending report. - **[Trended Reports Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_trendedtreports_id.htm)** Returns, deletes, or updates a trending report. # Trended Reports List Resource Returns a list of trending reports or creates a trending report. Resource URL /wave/trendedreports Formats JSON Available Version 37.0 HTTP Methods GET POST Response body for GET [Trended Report Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_trended_report_collection.htm "A collection of Analytics trended reports.") Request body for POST [Trended Report Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_trended_report_input.htm "An Analytics trended report.") Response body for POST [Trended Report](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_trended_report.htm "An Analytics trended report.") # Trended Reports Resource Returns, deletes, or updates a trending report. Resource URL /wave/trendedreports/ Formats JSON Available Version 37.0 HTTP Methods DELETE GET PATCH Request parameters for GET, PATCH, and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | trendedReportId | Id | The ID of the trended report. | Required | 37.0 | Response body for GET and PATCH [Trended Report](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_trended_report.htm "An Analytics trended report.") Request body for PATCH [Trended Report Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_trended_report_input.htm "An Analytics trended report.") # Two Column Layout A two column layout for an Analytics template wizard page. Properties Inherits properties from [Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_layout.htm "The base layout for an Analytics template wizard page."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | left | [Panel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel.htm "A panel in a column layout for an Analytics template wizard page.") | The left panel in the layout. | Small, 56.0 | 56.0 | | right | [Panel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel.htm "A panel in a column layout for an Analytics template wizard page.") | The right panel in the layout. | Small, 56.0 | 56.0 | # Typed Asset Reference A typed Analytics asset reference. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	ConnectWaveAssetTypeEnum	The asset type. Valid values are: `Collection` `Component` `ContextualDashboard` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataCloudReport` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `TableauDashboard` `TableauWorkbook` `Template` `Widget` `Workflow`	Small, 40.0	40.0

# Typed Asset Reference Input A typed Analytics asset reference. Properties

Property Name	Type	Description	Required or Optional	Available Version
`type`	ConnectWaveAssetTypeEnum	The asset type. Valid values are: `Collection` `Component` `ContextualDashboard` `Dashboard` `DashboardSavedView` `DashboardSnapshot` `DataCloudReport` `DataConnector` `Dataflow` `DataflowJob` `DataflowJobNode` `Dataset` `DatasetShard` `DatasetVersion` `ExternalData` `Folder` `Lens` `LightningComponent` `LightningDashboard` `LightningDashboardFolder` `Recipe` `RecipeConfiguration` `RecipeModel` `ReplicatedDataset` `Report` `ReportFolder` `Story` `TableauDashboard` `TableauWorkbook` `Template` `Widget` `Workflow`	Required	40.0

# UI Configuration Get the Analytics UI configuration data. JSON example { "maxGroups" : 4, "maxMeasures" : 4 } Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | maxGroups | Integer | The maximum number of groups. | Small, 36.0 | 36.0 | | maxMeasures | Integer | The maximum number of measures. | Small, 36.0 | 36.0 | # UI Definition The UI definition for an Analytics template. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | displayMessages | [DisplayMessage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_display_message.htm "The display message for an Analytics template.")\[\] | The display messages for this template configuration. | Small, 36.0 | 36.0 | | pages | [Page](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page.htm "A UI page for an Analytics template.")\[\] | The page collection for this template configuration. | Small, 36.0 | 36.0 | # UI Layout Definition The UI layout definition for an Analytics template. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | appDetails | [AppDetails](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_app_details.htm "The app details for a template configuration wizard page.") | The app details definition of the template configuration. | Small, 59.0 | 59.0 | | displayMessages | [DisplayMessage](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_display_message.htm "The display message for an Analytics template.")\[\] | A list of display messages for this template configuration. | Small, 56.0 | 56.0 | | navigationPanel | [NavigationPanel](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_navigation_panel.htm "The navigation panel for a template configuration wizard page.") | The navigation panel of the template configuration. | Small, 59.0 | 59.0 | | pages | [PageLayout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_layout.htm "The page layout definition for an Analytics template.")\[\] | A list of pages for this template configuration. | Small, 56.0 | 56.0 | # Unsupported Features Resource Returns the unsupported features for CRM Analytics in the current datacenter environment. ## Resource URL /wave/unsupportedFeatures ## Formats JSON ## Available Version 68.0 ## HTTP Methods POST ## Response body for POST [Wave Unsupported Features](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_unsupported_features.htm "The unsupported Analytics features for the org.") # Unsupported Record The sharing usage of object instances based on Analytics limits. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | descriptorCount | Integer | The number of descriptors for the record id. | Small, 51.0 | 51.0 | | id | String | The record id. | Small, 50.0 | 50.0 | # Unsupported Record Collection The collection of specific records that unsupported for sharing inheritance. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | count | Integer | The count of records not covered by sharing inheritance. This value may not match the length of the values collection. | Supplemental, 50.0 | 50.0 | | values | [UnsupportedRecord](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_unsupported_record.htm "The sharing usage of object instances based on Analytics limits.")\[\] | The collection of specific records that are unsupported for sharing inheritance. The collection length may be shorter than the count due to limiting for the API. | Small, 50.0 | 50.0 | # Use Postman to Send a CRM Analytics Request With Postman, you can explore and test your CRM Analytics API calls across multiple organizations with full control on headers, parameters, and content type. To make a request to your org: 1. Select the **CRM Analytics Collect API** folder to expand it. 2. To access a related collection of endpoints, select a subfolder. For this example, we use the Folders | GETWaveFolderCollection. 3. Click **Send**, and verify that the status is 200 OK.![Postman App's send button and 200 OK return](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/dev_guides/bi_dev_guide_rest/images/bi_postman_get_folder_collection.png) # User Collection Information for a user. Used by the Map representation Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The 18 character user ID | Small, 38.0 | 38.0 | | name | String | The name of the user | Small, 38.0 | 38.0 | # Validation Page Group An org readiness requirement group on a validation page for a template validation wizard page. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | includeUnmatched | Boolean | Indicates whether this group includes any requirements that aren't matched in other groups (true) or not (false). | Small, 59.0 | 59.0 | | tags | String\[\] | A list of tags for org readiness requirements that belong to this group. | Small, 59.0 | 59.0 | | text | String | The display text for the group. | Small, 59.0 | 59.0 | # Validation Page Layout The validation page layout for a template configuration wizard page. ## Properties Inherits properities from [Page Layout](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_page_layout.htm "The page layout definition for an Analytics template."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | groups | [ValidationPageGroup](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_validation_page_group.htm "An org readiness requirement group on a validation page for a template validation wizard page.")\[\] | A list of the org readiness groups to use for validation on this template wizard page. | Small, 59.0 | 59.0 | | header | [Header](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_header.htm "The header for an Analytics template wizard page.") | The header for the page. | Small, 59.0 | 59.0 | # Variable Definition The variable definition for an Analytics template. Specific variable type responses are listed here. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`computedValue`	Object	The computed value of the variable. This value is set by integrated apex implementations.	Small, 38.0	38.0
`defaultValue`	Object	The default value of the variable.	Small, 36.0	36.0
`description`	String	The description of the variable.	Small, 36.0	36.0
`excludeSelected`	Boolean	Indicates whether this variable excludes already selected values or not.	Small, 36.0	36.0
`excludes`	String[]	The list of values to exclude from the variable selection.	Small, 36.0	36.0
`label`	String	The label for the variable.	Small, 36.0	36.0
`mostRecentValue`	Object	The value specified in the most recent app creation process.	Small, 36.0	36.0
`required`	Boolean	Indicates whether the variable is required or not.	Small, 36.0	36.0
`variableType`	VariableType	The type of the variable. Valid variable types are: `ArrayType` `BooleanType` `CalculatedInsightFieldType` `CalculatedInsightType` `ConnectorType` `DataLakeObjectFieldType` `DataLakeObjectType` `DataModelObjectFieldType` `DataModelObjectType` `DatasetAnyFieldType` `DatasetDateType` `DatasetDimensionType` `DatasetMeasureType` `DatasetType` `DateTimeType` `NumberType` `ObjectType` `SObjectFieldType` `SObjectType` `StringType`	Small, 36.0	36.0

Array Type ArrayType inherits properties from the abstract [VariableType](#VariableType). These base properties appear in ArrayType alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | Object | The restricted list of enumerated values for the array. | Small, 36.0 | 36.0 | | itemsType | [VariableType](#VariableType) | The variable type contents of the array variable type. | Small, 36.0 | 36.0 | | sizeLimit | [SizeLimit](#SizeLimit) | The size limit of the array. | Small, 36.0 | 36.0 | Boolean Type BooleanType inherits properties from the abstract [VariableType](#VariableType). These base properties appear in BooleanType alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | Boolean\[\] | The restricted list of enumerated values for the boolean variable type. | Small, 36.0 | 36.0 | Connector Type ConnectorType inherits properties from the abstract [VariableType](#VariableType). These base properties appear in ConnectorType alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | String\[\] | The restricted list of enumerated string values for the connector variable type. | Small, 48.0 | 48.0 | Dataset Any Field Type DatasetAnyFieldType inherits properties from the abstract [BaseObjectType](#BaseObjectType). Dataset Date Type DatasetDateType inherits properties from the abstract [BaseObjectType](#BaseObjectType). Dataset Dimension Type DatasetDimensionType inherits properties from the abstract [BaseObjectType](#BaseObjectType). Dataset Measure Type DatasetMeasureType inherits properties from the abstract [BaseObjectType](#BaseObjectType). Dataset Type DatasetType inherits properties from the abstract [BaseObjectType](#BaseObjectType). Date Time Type DateTimeType inherits properties from the abstract [VariableType](#VariableType). Number Type NumberType inherits properties from the abstract [VariableType](#VariableType). These base properties appear in NumberType alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | Double\[\] | The restricted list of enumerated double values for the numeric variable type. | Small, 36.0 | 36.0 | | max | Double | The maximum allowed value of the number. | Small, 36.0 | 36.0 | | min | Double | The minimum allowed value of the number. | Small, 36.0 | 36.0 | Object Type ObjectType inherits properties from the abstract [BaseObjectType](#BaseObjectType). SObject Field Type SObjectFieldType inherits properties from the abstract [BaseObjectType](#BaseObjectType). These base properties appear in SObjectFieldType alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataType | String | The sObject field data type when a default field is not supplied. The valid data types are XSD data types, for example: xsd:string | Small, 36.0 | 36.0 | SObject Type SObjectType inherits properties from the abstract [BaseObjectType](#BaseObjectType). String Type StringType inherits properties from the abstract [VariableType](#VariableType). These base properties appear in StringType alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enums | String\[\] | The restricted list of enumerated values for the string variable type. | Small, 36.0 | 36.0 | Base Object Type BaseObjectType inherits properties from the abstract [VariableType](#VariableType). These base properties appear in BaseObjectType alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | properties | Map](#VariableType) | The defined properties and types of the object variable type. | Small, 36.0 | 36.0 | | required | String\[\] | The required properties of the object variable type. | Small, 36.0 | 36.0 | | strictValidation | Boolean | Indicates whether to use strict validation when unexpected properties exist in the object's payload or not. | Small, 36.0 | 36.0 | Variable Type

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	VariableTypeEnum	The type of the variable. Valid values are: `ArrayType` `BooleanType` `ConnectorType` `DatasetAnyFieldType` `DatasetDateType` `DatasetDimensionType` `DatasetMeasureType` `DatasetType` `DateTimeType` `NumberType` `ObjectType` `SobjectFieldType` `SobjectType` `StringType`	Small, 36.0	36.0

Size Limit | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | min | Integer | The minimum number of elements in the array. | Small, 37.0 | 37.0 | | max | Integer | The maximum number of elements in the array. | Small, 37.0 | 37.0 | # Variable Item A variable item on a panel for an Analytics template wizard page. ## Properties Inherits properties from [Panel Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_panel_item.htm "An item on a panel in a column layout for an Analytics template wizard page.").

Property Name	Type	Description	Filter Group and Version	Available Version
`description`	String	The description of the variable. If not specified, defaults to the variable description set in the variable resource.	Small, 59.0	59.0
`label`	String	The label of the variable.	Small, 56.0	56.0
`name`	String	The name of the variable.	Small, 56.0	56.0
`tiles`	Map<String, VariableItemTile>	A map of the checkbox tile details for the `CheckboxTiles` variant.	Small, 59.0	59.0
`variant`	String	The optional variable variant. The valid values are: `CheckboxTiles` `CenteredCheckboxTiles` `SubHeader`	Small, 59.0	59.0

# Variable Item Tile A variable item tile for a variable on a template wizard page. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | badge | String | The optional badge to display on the tile. | Small, 59.0 | 59.0 | | description | String | The description of the variable. If not specified, defaults to the variable description set in the variable resource. | Small, 59.0 | 59.0 | | iconName | String | The optional SLDS icon to display. | Small, 59.0 | 59.0 | | label | String | The label of the variable. If not specified, defaults to the variable label set in the variable resource. | Small, 59.0 | 59.0 | | visibility | String | The optional visibility expression for this tile. | Small, 60.0 | 60.0 | # Variable Type The abstract type for an Analytics template variable. ## Properties Inherited by [ArrayType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_array_type.htm "The array type of an Analytics template variable."), [BaseObjectType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_object_type.htm "The base type for an Analytics template object variable."), [BooleanType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_boolean_type.htm "The boolean type of an Analytics template variable."), [ConnectorType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_connector_type.htm "The connector type of an Analytics template variable."), [DateTimeType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_date_time_type.htm "The date time type of an Analytics template variable."), [NumberType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_number_type.htm "The number type of an Analytics template variable."), and [StringType](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_string_type.htm "The string type of an Analytics template variable.").

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	VariableTypeEnum	The type of the variable. Valid values are: `ArrayType` `BooleanType` `CalculatedInsightFieldType` `CalculatedInsightType` `ConnectorType` `DataLakeObjectFieldType` `DataLakeObjectType` `DataModelObjectFieldType` `DataModelObjectType` `DatasetAnyFieldType` `DatasetDateType` `DatasetDimensionType` `DatasetMeasureType` `DatasetType` `DateTimeType` `NumberType` `ObjectType` `SobjectFieldType` `SobjectType` `StringType`	Small, 36.0	36.0

# Video Info Information for describing a particular video. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	String	The platform-specific ID of the video content.	Small, 46.0	46.0
`label`	String	The title of the video.	Small, 46.0	46.0
`linkType`	ConnectTemplateVideoLinkTypeEnum	The video platform. Valid values are: `Vidyard` `YouTube`	Small, 46.0	46.0
`purpose`	ConnectTemplateVideoPurposeEnum	The video purpose. Valid values are: `Onboarding` `Walkthrough`	Small, 46.0	46.0
`showPlaylist`	Boolean	Indicates whether the video platform displays a playlist or not.	Small, 46.0	46.0

# Visual Parameters A visual parameters for an Analytics watchlist item. Properties | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | shouldIncrease | Boolean | Indicates whether the metric being watched should increase in value (true) or not (false). | Small, v49.0 | 49.0 | # Visual Parameters Input A visual parameters for an Analytics watchlist item. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | shouldIncrease | Boolean | Indicates whether the metric being watched should increase in value (true) or not (false). | Required | 49.0 | # Watchlist An Analytics watchlist collection. Properties Watchlist inherits properties from the abstract [BaseCollection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_collection.htm "The base Analytics collection."). These base properties appear in Watchlist alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | watchlistSnapshots | [WatchlistSnapshot](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist_snapshot.htm "An Analytics watchlist snapshot collection.")\[\] | The list of watchlist snapshots available to the current user. | Small, 48.0 | 48.0 | #### See Also - [Watchlist Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm "Return, create, and update a watchlist.") - [Watchlist Item Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_id.htm "Return, update, and delete a watchlist item.") - [Watchlist Schedules Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules.htm "Create a watchlist schedule.") - [Watchlist Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules_id.htm "Update a watchlist schedule.") # Watchlist Input An Analytics watchlist. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | watchlistItems | [WatchlistCollectionPinInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_item_input.htm "An Analytics watchlist item.")\[\] | The list of watchlist items. | Required | 49.0 | #### See Also - [Watchlist Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm "Return, create, and update a watchlist.") # Watchlist Item Input An Analytics watchlist item. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | scheduleId | String | The schedule id of the watchlist item. | Required | 48.0 | | watchlistWidgetItem | [WatchlistItemMetadataInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_item_metadata_input.htm "The metadata for an Analytics watchlist item.") | The metadata of the watchlist item. | Required | 48.0 | #### See Also - [Watchlist Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm "Return, create, and update a watchlist.") - [Watchlist Item Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_id.htm "Return, update, and delete a watchlist item.") # Watchlist Item Metadata Input The metadata for an Analytics watchlist item. Properties WatchlistItemMetadataInput inherits properties from the abstract [DashboardWidgetItemInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_dashboard_widget_item_input.htm "The base dashboard widget item."). These base properties appear in WatchlistItemMetadataInput alongside the properties defined explicitly in the following table.

Parameter Name	Type	Description	Required or Optional	Available Version
`driftState`	`ConnectDashboardSnapshotDriftState`	The drift state of the watchlist item. Valid values are: `Clean` (Indicates the snapshot is clean) `Dirty` (Indicates the snapshot has drifted and is dirty) `IgnoreQueryDrift` (Indicates the snapshot is dirty, but user has ignored it)	Required	49.0
`id`	String	The id of the watchlist item.	Required	49.0
`parameters`	`VisualParametersInput`	The visualization parameters of the watchlist item.	Required	49.0
`sortOrder`	Integer	The sort order of the watchlist item.	Required	49.0
`sourceDashboardId`	String	The source dashboard id of the watchlist item.	Required	49.0

# Watchlist Item Resource Return, update, and delete a watchlist item. Resource URL /wave/watchlist/ Formats JSON Available Version 48.0 HTTP Methods DELETE GET PATCH Request parameters for GET, PATCH, and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | watchlistItemId | ID | The ID of the watchlist item to return. | Required | 48.0 | Response body for GET [Dashboard Snapshot Item Result](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item_result.htm "An Analytics dashboard snapshot item.") Request body for PATCH [Watchlist Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_item_input.htm "An Analytics watchlist item.") Response body for PATCH [Watchlist](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist.htm "An Analytics watchlist collection.") # Watchlist Resource Return, create, and update a watchlist. Resource URL /wave/watchlist Formats JSON Available Version 48.0 HTTP Methods GET PATCH POST Response body for GET, PATCH, and POST [Watchlist](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist.htm "An Analytics watchlist collection.") Request body for PATCH [Watchlist Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_input.htm "An Analytics watchlist.") Request body for POST [Watchlist Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_item_input.htm "An Analytics watchlist item.") # Watchlist Resources Manages watchlists for Analytics dashboards. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Watchlist Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm "Return, create, and update a watchlist.") | Return, create, and update a watchlist. | GET POST PATCH | /wave/watchlist | | [Watchlist Item Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_id.htm "Return, update, and delete a watchlist item.") | Return, update, and delete a watchlist item. | GET PATCH DELETE | /wave/watchlist/ | | [Watchlist Schedules Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules.htm "Create a watchlist schedule.") | Create a watchlist schedule. | POST | /wave/watchlist/schedules | | [Watchlist Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules_id.htm "Update a watchlist schedule.") | Update a watchlist schedule. | PATCH | /wave/watchlist/schedules/ | - **[Watchlist Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist.htm)** Return, create, and update a watchlist. - **[Watchlist Item Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_id.htm)** Return, update, and delete a watchlist item. - **[Watchlist Schedules Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules.htm)** Create a watchlist schedule. - **[Watchlist Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules_id.htm)** Update a watchlist schedule. # Watchlist Schedule Input An Analytics watchlist schedule. Properties WatchlistScheduleInput inherits properties from the abstract [BaseSubscriptionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_subscription_input.htm "The base subscription request input."). #### See Also - [Watchlist Schedules Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules.htm "Create a watchlist schedule.") - [Watchlist Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_watchlist_schedules_id.htm "Update a watchlist schedule.") # Watchlist Schedule Resource Update a watchlist schedule. Resource URL /wave/watchlist/schedules/ Formats JSON Available Version 53.0 HTTP Methods PATCH Request parameters for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | scheduleId | ID | The ID of the schedule to update. | Required | 53.0 | Request body for PATCH [Watchlist Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_schedule_input.htm "An Analytics watchlist schedule.") Response body for PATCH [Watchlist](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist.htm "An Analytics watchlist collection.") # Watchlist Schedules Resource Create a watchlist schedule. Resource URL /wave/watchlist/schedules Formats JSON Available Version 48.0 HTTP Methods POST Request body for POST [Watchlist Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_watchlist_schedule_input.htm "An Analytics watchlist schedule.") Response body for POST [Watchlist](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_watchlist.htm "An Analytics watchlist collection.") # Watchlist Snapshot An Analytics watchlist snapshot collection. Properties WatchlistSnapshot inherits properties from the abstract [Snapshot](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_snapshot.htm "An Analytics snapshot."). These base properties appear in WatchlistSnapshot alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | snapshotItems | [DashboardSnapshotItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dashboard_snapshot_item.htm "An Analytics dashboard snapshot item.")\[\] | The list of watchlist items available to the current user. | Small, 48.0 | 48.0 | # Wave Analytics Limit An Analytics limit. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`current`	Double	The total current used amount.	Small, 51.0	51.0
`interval`	`ConnectAnalyticsLimitIntervalEnum`	The interval in which the limit is applied. Valid values are: `Daily` `Hourly` `Monthly` `None` `Weekly`	Small, 51.0	51.0
`licenseAttributes`	`LicensesAttributes`	The Analytics license type and other properties.	Small, 51.0	51.0
`max`	Long	The maximum count that Analytics allows.	Small, 51.0	51.0
`threshold`	Long	The threshold value to issue a warning before reaching the `max`.	Small, 51.0	51.0
`type`	ConnectAnalyticsLimitTypeEnum	The limit type. Valid values are `BatchTransformationHours` (Maximum dataflow runtime per month) `DatasetQueries` (Maximum queries on datasets for all users) `DatasetRowCount` (Maximum row of all datasets combined) `MaxDailyRowsDataCloudOutputCon` (Maximum rows for Data 360 output per rolling 24-hour period) `MaxDailyRowsHighOutputCon` (Maximum rows for all high volume tier output connectors per rolling 24-hour period) `MaxDailyRowsLowOutputCon` (Maximum rows for all low volume tier output connectors per rolling 24-hour period) `MaxDailyRowsMedOutputCon` (Maximum rows for all medium volume tier output connectors per rolling 24-hour period) `MaxDailySizeHighOutputCon` (Maximum data size for all high volume tier output connectors per rolling 24-hour period) `MaxDailySizeLowOutputCon` (Maximum data size for all low volume tier output connectors per rolling 24-hour period) `MaxDailySizeMedOutputCon` (Maximum data size for all medium volume tier output connectors per rolling 24-hour period) `MaxDailySizeVirtualPrivateCloudCon` (Maximum cumulative bytes of data sent through connections using a virtual private cloud in a rolling 24-hour period) `MaxDailyUploadVolume` (Maximum cumulative bytes of data files uploaded to Salesforce in a rolling 24-hour period) `MaxDailyWorkflowExecutions` (Maximum number of dataflow and recipe runs in a rolling 24-hour period) `MaxRecipeOutRowsPerMonth` (Maximum number of rows output by all recipes to all datasets in a month) `MaxReplicatedObjects` (Maximum number of connected objects) `OutputLocalConnectorVolume` (Maximum cumulative bytes of data files written to Salesforce in a rolling 24-hour period) `StagedDatasetRowCount` (Maximum rows for staged datasets)	Small, 51.0	51.0

# Wave Analytics Limit Collection The collection of Analytics limits. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | limits | [WaveAnalyticsLimit](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_analytics_limit.htm "An Analytics limit.")\[\] | A collection of Analytics limits. | Small, 51.0 | 51.0 | #### See Also - [Limits Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_limits.htm "The Analytics limits for the Salesforce org.") # Wave Asset Bundle The Analytics asset bundled with the associated metadata. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | asset | [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset.") | The primary asset for the bundle. | Small, 43.0 | 43.0 | | components | [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset.")\[\] | The metadata of components for the bundle. | Small, 50.0 | 50.0 | | datasets | [Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset.htm "An Analytics dataset.")\[\] | A list of datasets for the bundle. | Small, 41.0 | 41.0 | | id | String | The ID of the primary asset for the bundle. | Small, 41.0 | 41.0 | | sobjects | [AssetReference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_asset_reference.htm "An Analytics asset reference.")\[\] | A list of sObjects for the bundle. | Small, 50.0 | 50.0 | | xmds | [Xmd](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd.htm "The extended metadata (Xmd) for an Analytics dataset version.")\[\] | A list of xmds for the bundle. | Small, 41.0 | 41.0 | #### See Also - [Dashboard Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_dashboards_id_bundle.htm "Returns or updates the dashboard bundle with the specified ID or API name.") - [Lens Bundle Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_bundle.htm "Returns or updates the lens bundle with the specified ID or API name.") # Wave Collection A collection of Analytics resources. Properties

Parameter Name	Type	Description	Filter Group and Version	Available Version
`collectionType`	CollectionTypeEnum	The collection type. Valid values are: `Static`	Small, v52.0	52.0
`color`	String	The configured color for the collection, represented as a hexadecimal value.	Supplemental, v52.0	52.0
`isPinned`	`Boolean`	Indicates whether this collection is pinned for the current user (`true`) or not (`false`).	Small, v52.0	52.0
`isVisible`	`Boolean`	Indicates whether this collection is visible for the current user (`true`) or not (`false`).	Small, v57.0	57.0
`itemList`	WaveCollectionItemList[]	The list of items in the collection.	Small, 52.0	52.0
`itemsUrl`	`Boolean`	The URL to get the items in the collection.	Small, v52.0	52.0
`pinnedBy`	CollectionCreatedByTypeEnum	The type of user who created the pin. Valid values are: `Admin` `None` `User`	Small, v57.0	57.0
`pins`	CollectionPin[]	The list of pinning rules for the collection.	Small, 52.0	52.0
`shares`	WaveFolderShare[]	The list of sharing rules for the collection.	Small, 52.0	52.0

#### See Also - [Collections List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections.htm "Returns a list of collections or creates a collection. Each collection contains Analytics resource items.") - [Collections Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_collections.htm "Returns, updates, or deletes a collection. Each collection contains Analytics resource items.") - [Collections Item Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_item.htm "Deletes an item from the collection.") # Wave Collection Input A collection of Analytics resources. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | color | String | The configured color for the collection, represented as a hexadecimal value. | Optional | 52.0 | | description | String | The description for the collection. | Optional | 52.0 | | label | String | The label of the collection. | Required | 52.0 | | pins | [WaveCollectionPinInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_pin_input.htm "The pinning rules for an Analytics collection.")\[\] | The list of pinning rules for the collection. | Optional | 52.0 | | shares | [WaveFolderShareInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_folder_share_input.htm "An Analytics folder sharing rule.")\[\] | The list of sharing rules for the collection. | Optional | 52.0 | | collectionType | CollectionTypeEnum | The collection type. Valid values are: Static | Required | 52.0 | #### See Also - [Collection List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections.htm "Returns a list of collections or creates a collection. Each collection contains Analytics resource items.") - [Collections Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_collections.htm "Returns, updates, or deletes a collection. Each collection contains Analytics resource items.") # Wave Collection Item An item in a collection of Analytics resources. Properties

Parameter Name	Type	Description	Filter Group and Version	Available Version
`assetType`	CollectionItemAssetTypeEnum	The collection item asset type. Valid values are: `Dashboard` `Lens`	Small, 52.0	52.0
`collectionItemId`	String	The id of the association between the collection and asset item.	Small, v52.0	52.0
`files`	BaseFile[]	The list of files used to create the asset item. Valid values are: AnalyticsDataAssetFile LensFile	Small, v52.0	52.0
`folder`	AssetReference	The folder metadata for the asset item.	Small, v52.0	52.0
`visibility`	ConnectWaveAssetVisibilityType	Indicates whether the asset is hidden from users with view access or not. Valid values are: `All` (Show all assets) `Limited` (Hide assets from viewers with view access)	Small, v52.0	52.0

#### See Also - [Collections Items List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm "Returns a list of Analytics collection items and creates or updates the collection item list.") # Wave Collection Item Bulk Add Input Bulk items to add to a collection of Analytics resources. ## Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | items | [WaveCollectionItemInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_input.htm "An item in a collection of Analytics resources.")\[\] | The list of items to add to the collection | Required | 63.0 | #### See Also - [Collections Bulk Items Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_bulk_items.htm "Add items in bulk to the collection.") # Wave Collection Item Input An item in a collection of Analytics resources. Properties

Parameter Name	Type	Description	Required or Optional	Available Version
`assetType`	CollectionItemAssetTypeEnum	The collection item asset type. Valid values are: `Component` `Dashboard` `DashboardSavedView` `Lens` `LightningDashboard` `Report` `TableauDashboard` `TableauWorkbook`	Required	52.0
`id`	ID	The ID of the collection item.	Required	52.0
`itemId`	ID	The ID of the item.	Required	52.0

#### See Also - [Collection Items List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_item.htm "Deletes an item from the collection.") # Wave Collection Item List A list of items in a collection of Analytics resources. Properties | Parameter Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | collectionItems | [WaveCollectionItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection_item.htm "An item in a collection of Analytics resources.")\[\] | The list of collection items. | Small, 52.0 | 52.0 | | nextPageToken | String | The token for the next page if there are more items. | Small, v52.0 | 52.0 | | totalCount | Integer | The total count of collection items. | Small, v52.0 | 52.0 | #### See Also - [Collections Items List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm "Returns a list of Analytics collection items and creates or updates the collection item list.") # Wave Collection Item List Input A list of items in a collection of Analytics resources. Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | items | [WaveCollectionItemInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_wave_collection_item_input.htm "An item in a collection of Analytics resources.")\[\] | The list of collection items. | Small, 52.0 | 52.0 | #### See Also - [Collection Items List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm "Returns a list of Analytics collection items and creates or updates the collection item list.") # Wave Collection List A list of Analytics collections. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | collections | [WaveCollection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_collection.htm "A collection of Analytics resources.")\[\] | A collection of Analytics resources. | Small, 52.0 | 52.0 | | nextPageToken | String | The next page token if there are more records in the collection. | Small, 52.0 | 52.0 | | totalCollectionCount | Integer | The total size of the accessible items in the collections, with no visibility or pinning filters applied. | Small, 57.0 | 57.0 | | totalCount | Integer | The total count of collections. | Small, 52.0 | 52.0 | #### See Also - [Collections Items List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_collections_items.htm "Returns a list of Analytics collection items and creates or updates the collection item list.") # Wave Collection Pin Input The pinning rules for an Analytics collection. Properties

Parameter Name	Type	Description	Required or Optional	Available Version
`pinnedFor`	ID	The id of a group, a role, or a user the pinning rule is defined for.	Required	52.0
`pinnedForType`	ConnectWaveShareTypeEnum	The share type for the pinning rule. Valid values are: `AllCspUsers` `AllPrmUsers` `CustomerPortalUser` `Group` `Organization` `PartnerUser` `PortalRole` `PortalRoleAndSubordinates` `Role` `RoleAndSubordinates` `RoleAndSubordinatesInternal` `User`	Required	52.0
`type`	CollectionPinTypeEnum	The type of pinning. Valid values are: `All` `Desktop` `Mobile` `None`	Optional	52.0

# Wave Features The Analytics features enabled for a user. ## JSON example { "canCreateAndEditDashboards" : true, "canCreateApplications" : true, "isWaveCommunitiesUser" : false } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | canAccessFirebirdEditor | Boolean | Indicates whether the user can access the Recipes 3.0 editor (true) or not (false). | Small, 48.0 | 48.0 | | canCreateAndEditDashboards | Boolean | Indicates whether the user can create and edit Dashboards (true) or not (false). | Small, 36.0 | 36.0 | | canCreateApplications | Boolean | Indicates whether the user can create applications (true) or not (false). | Small, 36.0 | 36.0 | | canEditReplication | Boolean | Indicates whether the user can edit data sync setup (true) or not (false). | Small, 37.0 | 37.0 | | canManageTemplatesInStudio | Boolean | Indicates whether the user can manage app templates within Analytics Analytics Studio (true) or not (false). | Small, 52.0 | 52.0 | | canUpdateDataCloudObject | Boolean | Indicates whether the org can update Data 360 objects (true) or not (false). | Small, 66.0 | 66.0 | | canUploadExternalData | Boolean | Indicates whether the user can upload external data (true) or not (false). | Small, 36.0 | 36.0 | | canUseAppTemplates | Boolean | Indicates whether the user can access application templates (true) or not (false). | Small, 45.0 | 45.0 | | canUseDashboardSavedViews | Boolean | Indicates whether the org has dashboard saved views enabled (true) or not (false). | Small, 42.0 | 42.0 | | canUseDataPrepPilot | Boolean | Indicates whether the org has the Data Prep pilot feature enabled (true) or not (false). | Small, 51.0 | 51.0 | | canUseExploreRecommendation | Boolean | Indicates whether the org has asset recommendation enabled (true) or not (false). | Small, 57.0 | 57.0 | | canUseJSLayoutOnMobile | Boolean | Indicates whether the org can use the JS engine to layout widgets in a dashboard on mobile apps (true) or not (false). | Small, 60.0 | 60.0 | | canUseUnifiedAnalytics | Boolean | Indicates whether the org has unified analytics enabled (true) or not (false). | Small, 55.0 | 55.0 | | canUseWatchRecommendation | Boolean | Indicates whether the org has watch asset recommendation enabled (true) or not (false). | Small, 57.0 | 57.0 | | canUseWave | Boolean | Indicates whether the user can access Analytics (true) or not (false). | Small, 36.0 | 36.0 | | canUseWaveAnnotation | Boolean | Indicates whether the user can access annotations (true) or not (false). | Small, 45.0 | 45.0 | | canUseWaveSparkELT | Boolean | Indicates whether the user can access updated ELT features (true) or not (false). | Small, 47.0 | 47.0 | | canWriteToDataCloud | Boolean | Indicates whether the org has write access to Data 360 (true) or not (false). | Small, 60.0 | 60.0 | | dmoCreationEnabled | Boolean | Indicates whether the org can create data model objects (DMO) in Data 360 (true) or not (false). | Small, 68.0 | 68.0 | | isWaveCommunitiesUser | Boolean | Indicates whether the user is an Analytics Communities user (true) or not (false). | Small, 36.0 | 36.0 | | orgCanViewTableau | Boolean | Indicates whether the org has view access to Tableau dashboards enabled (true) or not (false). | Small, 55.0 | 55.0 | | orgCanViewTableauWorkbook | Boolean | Indicates whether the org has view access to Tableau workbooks enabled (true) or not (false). | Small, 58.0 | 58.0 | | orgCanViewThumbnailsForOA | Boolean | Indicates whether the org has view access to thumbnails for Lightning Experience reports and dashboards enabled (true) or not (false). | Small, 57.0 | 57.0 | | orgHasAppFramework3\_0 | Boolean | Indicates whether the org has the App Framework 3.0 enabled (true) or not (false). | Small, 54.0 | 54.0 | | orgHasCustomFiscal | Boolean | Indicates whether the org has Analytics custom fiscal enabled (true) or not (false). | Small, 54.0 | 54.0 | | orgHasDataCloudReportingEnabled | Boolean | Indicates whether the org has Data 360 reporting enabled (true) or not (false). | Small, 58.0 | 58.0 | | orgHasEltOrchestration | Boolean | Indicates whether the org has ETL orchestration enabled (true) or not (false). | Small, 55.0 | 55.0 | | orgHasExploreInTableau | Boolean | Indicates whether the org has data exploration in Tableau enabled (true) or not (false). | Small, 55.0 | 55.0 | | orgHasFavorites | Boolean | Indicates whether the org has favorites enabled (true) or not (false). | Small, 49.0 | 49.0 | | orgHasFirebirdEditor | Boolean | Indicates whether the org has Recipes 3.0 enabled (true) or not (false). | Small, 48.0 | 48.0 | | orgHasMobileOfflineEnabled | Boolean | Indicates whether the org has mobile offine enabled (true) or not (false). | Small, 51.0 | 51.0 | | orgHasOptimizedAppendEnabled | Boolean | Indicates whether the org has optimized append for recipes enabled (true) or not (false). | Small, 62.0 | 62.0 | | orgHasOptimizedUpdateEnabled | Boolean | Indicates whether the org has optimized update for recipes enabled (true) or not (false). | Small, 65.0 | 65.0 | | orgHasRecipeDirectData | Boolean | Indicates whether the org has access to data directly from recipes (true) or not (false). | Small, 52.0 | 52.0 | | orgHasRecipeFiscal | Boolean | Indicates whether the org has recipe fiscal configuration enabled (true) or not (false). | Small, 54.0 | 54.0 | | orgHasRecipeStagedData | Boolean | Indicates whether the org has access to staged data from recipes (true) or not (false). | Small, 53.0 | 53.0 | | orgHasTableauSeamlessAuth | Boolean | Indicates whether the org has token authentication for Tableau configured (true) or not (false). | Small, 60.0 | 60.0 | | orgHasWatchlistEnabled | Boolean | Indicates whether the org has watchlist enabled (true) or not (false). | Small, 49.0 | 49.0 | | orgHasWaveNullDimensionSAQLEnabled | Boolean | Indicates whether the org has null dimensions for CRM Analytics SAQL enabled (true) or not (false). | Small, 61.0 | 61.0 | | sdmCreationEnabled | Boolean | Indicates whether the org can create semantic models in Data 360 (true) or not (false). | Small, 68.0 | 68.0 | | secPredicateTranslEnabled | Boolean | Indicates whether the org has security predicate translation for writes to Data 360 enabled (true) or not (false). | Small, 68.0 | 68.0 | | specialGroupIdForOrg | Boolean | Indicates whether the org has a special group ID (true) or not (false). | Small, 55.0 | 55.0 | | userCanUseInsights | Boolean | Indicates whether the user can use Analytics (true) or not (false). | Small, 55.0 | 55.0 | | userCanViewRecipes | Boolean | Indicates whether the user has read-only access to recipes (true) or not (false). | Small, 62.0 | 62.0 | | userHasCdcReportingManageFolders | Boolean | Indicates whether the user can manage Data 360 report folders (true) or not (false). | Small, 58.0 | 58.0 | | userHasCdcReportingViewFolders | Boolean | Indicates whether the user can view Data 360 report folders (true) or not (false). | Small, 58.0 | 58.0 | | userHasCdcReportingViewReports | Boolean | Indicates whether the user can view Data 360 reports (true) or not (false). | Small, 58.0 | 58.0 | | userHasDataCloudReportingEnabled | Boolean | Indicates whether the user can export Data 360 reports enabled (true) or not (false). | Small, 58.0 | 58.0 | | userHasDataCloudTabluarDownload | Boolean | Indicates whether the user can export Data 360 data (true) or not (false). | Small, 62.0 | 62.0 | | userUseInsightsAdmin | Boolean | Indicates whether the user is an CRM Analtyics admin (true) or not (false). | Small, 55.0 | 55.0 | | userHasWatchEnabled | Boolean | Indicates whether the user has Analytics watch enabled (true) or not (false). | Small, 58.0 | 58.0 | #### See Also - [Features Configuration Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_config_features.htm "The Analytics features that are available to a user.") # Wave File Metadata The metadata for an Analytics file. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | createdBy | [WaveUser](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_user.htm "An Analytics user.") | The user that created the file. | Medium, 36.0 | 36.0 | | createdDate | Date | The created date of the file. | Medium, 36.0 | 36.0 | | id | String | The 18 character file ID. | Small, 36.0 | 36.0 | | lastAccessedDate | Date | The last accessed date of the file. | Medium, 36.0 | 36.0 | | lastModifiedDate | Date | The last modified date of the file. | Medium, 36.0 | 36.0 | | length | Integer | The size of the binary file. | Small, 36.0 | 36.0 | | name | String | The name of the file. | Small, 36.0 | 36.0 | | url | String | The URL of the file. | Small, 36.0 | 36.0 | #### See Also - [Lens File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_files_id.htm "Returns or updates a file that is part of an Analytics lens.") - [Lens File Metadata Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_files.htm "Returns or creates the lens file metadata with the specified ID or API name.") # Wave File Metadata Collection A collection of the metadata for Analytics files. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | files | [WaveFileMetadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_file_metadata.htm "The metadata for an Analytics file.")\[\] | The list of file metadata. | Small, 36.0 | 36.0 | | nextPageUrl | String | The URL to get the next page of contents in the collection. | Small, 36.0 | 36.0 | | totalSize | Integer | The total count of the elements in the collection irrespective of the page. | Medium, 36.0 | 36.0 | | url | String | The URL to get the collection. | Small, 36.0 | 36.0 | #### See Also - [Lens File Metadata Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_lenses_id_files.htm "Returns or creates the lens file metadata with the specified ID or API name.") # Wave Folder An Analytics folder. Properties WaveFolder inherits properties from the abstract [BaseWaveAsset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_base_wave_asset.htm "The base Analytics asset."). These base properties appear in WaveFolder alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`appLog`	AppLog	The application log from the creation or upgrade of the application.	Supplemental, 49.0	49.0
`applicationStatus`	ConnectWaveApplicationStatusEnum	The creation status of application. Valid values are: `CancelledStatus` `CompletedStatus` `DataflowInProgressStatus` `ExtensionAssetTypeInProgressStatus` `FailedStatus` `InProgressStatus` `NewStatus`	Medium, 36.0	36.0
`attachedFiles`	AssetReference[]	The id's of the files attached to the Analytics folder	Big, 39.0	39.0
`canBeSharedExternally`	Boolean	Indicates whether this app can be shared with Experience Cloud site users (`true`) or not (`false`).	Big, 37.0	37.0
`defaultAsset`	AssetReference	The default dashboard or lens that is presented when the app is viewed in App Runtime mode.	Big, 37.0	37.0
`featuredAssets`	Map<String, FeaturedAssets>	The map of featured assets for this application to be used in the UI.	Big, 39.0	39.0
`icon`	AssetReference	The asset icon.	Small, 36.0	36.0
`installationHistoryUrl`	String	The URL to the app's installation history.	Small, 56.0	56.0
`isPinned`	Boolean	Indicates whether this app is pinned (`true`) or not (`false`).	Small, 39.0	39.0
`schedule`	Map<String, WaveFolderSchedule>	The reoccurring schedule for app related tasks, like data refresh.	Big, 57.0	57.0
`shares`	WaveFolderShare[]	The folder shares list.	Big, 36.0	36.0
`templateOptions`	TemplateOptions	The options used on the last action performed on a templated Analytics application.	Big, 37.0	37.0
`templateSourceId`	String	The source template ID or api name used to create the folder or application.	Medium, 36.0	36.0
`templateValues`	Map<String, Object>	The map of template values used to create or update the folder or application.	Big, 37.0	37.0
`templateVersion`	String	The version of the template this application was created from.	Medium, 37.0	37.0

#### See Also - [Folders List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm "Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.") - [Folder Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm "Returns, deletes, updates, or replaces an Analytics app or folder with the specified ID.") # Wave Folder Collection A collection of Analytics folders. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | folders | [WaveFolder\[\]](bi_responses_wave_folder.htm "An Analytics folder.") | A list of folders or applications. | Small, 36.0 | 36.0 | | nextPageUrl | String | The URL for the next page of content in the collection. | Small, 36.0 | 36.0 | | totalSize | Integer | The total count of the elements in the collection. | Medium, 36.0 | 36.0 | | url | String | The URL for the collection. | Small, 36.0 | 36.0 | #### See Also - [Folders List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm "Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.") # Wave Folder Input An Analytics folder. This implements BaseWaveFolderInput. ## Properties Inherits from [Base Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_wave_folder_input.htm "The base Analytics folder asset.")

Property Name	Type	Description	Required or Optional	Available Version
`applicationStatus`	ConnectWaveApplicationStatusEnum	The creation status of application. Valid values are: `CancelledStatus` `CompletedStatus` `DataflowInProgressStatus` `ExtensionAssetTypeInProgressStatus` `FailedStatus` `InProgressStatus` `NewStatus`	Required	36.0
`attachedFiles`	AssetReferenceInput[]	The list of attached file IDs.	Required	39.0
`canBeSharedExternally`	Boolean	Indicates whether the app is shared in Communities (`true`) or not (`false`).	Required	39.0
`defaultAsset`	AssetReferenceInput	The default dashboard or lens presented for this app during app runtime.	Required	37.0
`featuredAssets`	Map<String, FeaturedAssetsInput>	The map of featured assets for this application to be used in the UI.	Required	39.0
`isPinned`	Boolean	Indicates whether the app is a pinned app (`true`) or not (`false`).	Required	39.0
`shares`	WaveFolderShareInput[]	The folder shares list.	Required	36.0

#### See Also - [Folders List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm "Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.") - [Folder Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm "Returns, deletes, updates, or replaces an Analytics app or folder with the specified ID.") # Wave Folder Schedule An Analytics folder schedule. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataRefreshSchedule | [ScheduledItem](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_scheduled_item.htm "The base schedule for a data refresh.") | The reoccurring schedule for performing data refresh for an Analytics app. | Small, 57.0 | 57.0 | | url | String | The URL of the schedule. | Small, 57.0 | 57.0 | #### See Also - [Folder Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_schedule.htm "Returns, deletes, or updates the schedule for an Analytics app or folder with the specified ID.") # Wave Folder Schedule Input An Analytics folder schedule. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dataRefreshSchedule | [ScheduledItemInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_scheduled_item_input.htm "The base schedule for a data refresh.") | The reoccurring schedule for performing data refresh for an Analytics app. | Required | 57.0 | #### See Also - [Folder Schedule Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id_schedule.htm "Returns, deletes, or updates the schedule for an Analytics app or folder with the specified ID.") # Wave Folder Share An Analytics folder sharing rule. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`accessType`	ConnectWaveAccessTypeEnum	The access type. Valid values are: `Edit` `Manage` `View`	Small, 36.0	36.0
`imageUrl`	String	The URL of the user image.	Small, 36.0	36.0
`shareType`	ConnectWaveShareTypeEnum	The share type. Valid values are: `AllCspUsers` `AllPrmUsers` `CustomerPortalUser` `Group` `Organization` `PartnerUser` `PortalRole` `PortalRoleAndSubordinates` `Role` `RoleAndSubordinates` `RoleAndSubordinatesInternal` `User`	Small, 36.0	36.0
`sharedWithId`	String	The ID of the user with the share representation.	Small, 36.0	36.0
`sharedWithLabel`	String	The label for the shared user, group, or org.	Small, 36.0	36.0
`uniqueName`	String	The unique name of the entity that the folder is shared with, applicable only to a user.	Small, 60.0	60.0

# Wave Folder Share Input An Analytics folder sharing rule. Properties

Property Name	Type	Description	Required or Optional	Available Version
`accessType`	ConnectWaveAccessTypeEnum	The access type. Valid values are: `Edit` `Manage` `View`	Required	36.0
`shareType`	ConnectWaveShareTypeEnum	The share type. Valid values are: `AllCspUsers` `AllPrmUsers` `CustomerPortalUser` `Group` `Organization` `PartnerUser` `PortalRole` `PortalRoleAndSubordinates` `Role` `RoleAndSubordinates` `RoleAndSubordinatesInternal` `User`	Required	36.0
`sharedWithId`	ID	The ID of the entity that the folder is shared with.	Required	36.0

# Wave Folder Template Input A templated Analytics folder. This implements BaseWaveFolderInput. ## Properties Inherits from [Base Wave Folder Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_base_wave_folder_input.htm "The base Analytics folder asset.") | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | templateOptions | [TemplateOptionsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_template_input.htm "An Analytics template.") | The template directive options for determining the final actions when upgraded a Analytics app from a template. | Required | 37.0 | | templateSourceId | String | The template source ID or API name used to create the Analytics app. | Required | 36.0 | | templateValues | String | The runtime template values to use when creating a Analytics app, as specified by the template. | Required | 36.0 | #### See Also - [Folders List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders.htm "Returns a collection of apps or folders and creates an Analytics app, which is a folder that contains Analytics dataset, lenses, and dashboard.") - [Folder Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_folders_id.htm "Returns, deletes, updates, or replaces an Analytics app or folder with the specified ID.") # Wave Resource Lists the top-level resources available for Analytics. Resource URL /wave Formats JSON Available Version 36.0 HTTP Methods GET Response body for GET [Directory Item Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_directory_item_collection.htm "A collection of directory items.") # Wave Unsupported Features The unsupported Analytics features for the org. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | waveUnsupportedFeatures | String\[\] | A list of the unsupported feature identifiers. | Small, 68.0 | 68.0 | # Wave User An Analytics user. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The 18-character user ID. | Small, 36.0 | 36.0 | | name | String | The name of the user. | Small, 36.0 | 36.0 | | profilePhotoUrl | String | The Chatter profile photo of the user. | Small, 36.0 | 36.0 | # Weekly Schedule Specify a schedule that runs weekly for an Analytics asset. Properties Inherits notificationLevel, and time from [Schedule](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm "A schedule on which to execute some type of Analytics asset job.")

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 39.0	39.0

# Weekly Schedule Input Specify a weekly schedule for an Analytics asset. Properties Inherits notification, and time from [Schedule Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_schedule_input.htm "A schedule on which to execute some type of Analytics asset.")

Property Name	Type	Description	Required or Optional	Available Version
`daysOfWeek`	ConnectWaveDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Required	39.0

# Weekly Scheduled Item The weekly schedule for a data refresh. Properties Inherits properties from [Scheduled Item](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_scheduled_item.htm "The base schedule for a data refresh.")

Property Name	Type	Description	Filter Group and Version	Available Version
`daysOfWeek`	ConnectJsonXformDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Small, 57.0	57.0

# Weekly Scheduled Item Input The weekly schedule for a data refresh. Properties Inherits properties from [Scheduled Item Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_scheduled_item_input.htm "The base schedule for a data refresh.")

Property Name	Type	Description	Required or Optional	Available Version
`daysOfWeek`	ConnectJsonXformDayOfWeekEnum[]	Days of the week on which the schedule runs. Valid values are: `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday` `Sunday`	Required	57.0

# Widget Subscription Source The widget subscription source. Properties WidgetSubscriptionSource inherits properties from the abstract [SubscriptionSource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_subscription_source.htm "The base Analytics subscription source."). # Widget Subscription Source Input The widget subscription source. Properties WidgetSubscriptionSourceInput inherits properties from the abstract [SourceDetailsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_source_details_input.htm "The abstract source details for a subscription."). # Xmd The extended metadata (Xmd) for an Analytics dataset version. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`createdBy`	WaveUser	The user who created the Xmd.	Small, 36.0	36.0
`createdDate`	Date	The time at which the Xmd was created, in ISO8601 date format.	Small, 36.0	36.0
`dataset`	XmdDataset	Locale-specific information about the dataset represented by this Xmd.	Small, 36.0	36.0
`dates`	XmdDate[]	A list of dates with formatting information.	Small, 36.0	36.0
`derivedDimensions`	XmdDimension[]	A list of derived dimensions with formatting information.	Small, 36.0	36.0
`derivedMeasures`	XmdMeasure[]	A list of derived measures with formatting information.	Small, 36.0	36.0
`dimensions`	XmdDimension[]	A list of dimensions with formatting information.	Small, 36.0	36.0
`errorMessage`	String	The message if there was error copying forward the current version's user Xmd to the newly created version.	Small, 37.0	37.0
`language`	ConnectWaveLanguageEnum	The language in which this Xmd is localized. Values are: `bg`: Bulgarian `zh_CN`: Chinese Simplified `zh_TW`: Chinese Traditional `hr`: Croatian `cs`: Czech `da`: Danish `nl_NL`: Dutch `en`: English `en_GB`: English (United Kingdom) `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 `ru`: Russian `sk`: Slovak `sl`: Slovenian `es`: Spanish `es_MX`: Spanish (Mexico) `sv`: Swedish `th`: Thai `tr`: Turkish `uk`: Ukrainian `vi`: Vietnamese	Small, 36.0	36.0
`lastModifiedBy`	WaveUser	The user who last updated the Xmd.	Small, 36.0	36.0
`lastModifiedDate`	Date	The last time the Xmd was modified, in ISO8601 date format.	Small, 36.0	36.0
`measures`	XmdMeasure[]	A list of measures with formatting information.	Small, 36.0	36.0
`organizations`	XmdOrganization[]	A list of organizations for multi-organization support.	Small, 36.0	36.0
`showDetailsDefaultFields`	String[]	An ordered list of dimensions and measures. The list defines the default order in which to show the dimensions and measures in the user interface.	Small, 36.0	36.0
`type`	ConnectWaveXmdTypeEnum	The type of Xmd. Values are: `asset` `main` `system` `user`	Small, 36.0	36.0
`url`	String	The location where this Xmd is stored.	Small, 36.0	36.0

#### See Also - [Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm "Returns the extended metadata (Xmd) for a version of a dataset and updates the user Xmd file.") - [Asset Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_asset.htm "Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard.") # Xmd Currency Settings The extended metadata (Xmd) for currency settings of a currency field. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | conversionRateDateField | String | The conversion rate date field used when the currency was converted.. | Small, 57.0 | 57.0 | | currencies | Map | A map for the supported currencies. | Small, 57.0 | 57.0 | # Xmd Currency Settings Input The extended metadata (Xmd) for currency settings of a currency field. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | currencies | Map | A map for the supported currencies. | Required | 57.0 | # Xmd Dataset The extended metadata (Xmd) for currency settings of a currency field. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | basecurrency | String | The base currency for the dataset. | Small, 57.0 | 57.0 | | connector | String | The connector source for the dataset. | Small, 36.0 | 36.0 | | description | String | The description of the dataset. | Small, 36.0 | 36.0 | | fullyQualifiedName | String | The fully qualified name for the dataset version. | Small, 36.0 | 36.0 | | origin | String | The origin for the dataset version. | Small, 36.0 | 36.0 | | supportedCurrencies | String\[\] | A list of the supported currencies for the dataset. | Small, 57.0 | 57.0 | # Xmd Dataset Input The extended metadata (Xmd) for an Analytics dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | connector | String | The connector source for the dataset. | Required | 36.0 | | description | String | The description of the dataset. | Optional | 36.0 | | fullyQualifiedName | String | The fully qualified name of the dataset version. | Required | 36.0 | | origin | String | The origin representing where this dataset version comes from. | Optional | 36.0 | # Xmd Date The extended metadata (Xmd) for a date. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`alias`	String	The alias of the Date column.	Small, 36.0	36.0
`compact`	Boolean	Indicates whether the date should be displayed as compact or not.	Small, 36.0	36.0
`description`	String	The description of the Date column.	Small, 36.0	36.0
`fields`	XmdDateField	The formatting information for the date fields.	Small, 36.0	36.0
`firstDayOfWeek`	Integer	Denotes the first day of the week.	Small, 36.0	36.0
`fiscalMonthOffset`	Integer	The offset number of months for the fiscal year in relation to the calendar year.	Small, 36.0	36.0
`format`	String	The format for date field.	Small, 53.0	53.0
`fullyQualifiedName`	String	The fully qualified name of the date.	Small, 39.0	39.0
`isConvertedDateTime`	Boolean	Indicates if the DateTime type is from timezone auto conversion or not.	Small, 44.0	44.0
`isYearEndFiscalYear`	Boolean	Indicates if the year end is the fiscal year or not.	Small, 36.0	36.0
`label`	String	The label of the Date column.	Small, 36.0	36.0
`showInExplorer`	Boolean	Indicates whether the dataset field can be selected from the dashboard designer or explorer when creating dashboards and lenses (`true`) or not (`false`). Even if `showInExplorer` is `false`, the field can still be used for SAQL queries, manually added in JSON, and accessed using the Analytics REST API.	Small, 36.0	36.0
`type`	ConnectWaveDateType	The Date type. Valid values are: `Date` `DateOnly` `DateTime`	Small, 43.0	43.0

# Xmd Date Field The extended metadata (Xmd) for the formatting of date fields. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | day | String | The day of the month. | Small, 36.0 | 36.0 | | epochDay | String | The number of days that have elapsed since January 1, 1970 (midnight UTC). | Small, 36.0 | 36.0 | | epochSecond | String | The number of seconds that have elapsed since January 1, 1970 (midnight UTC). Corresponds to \_sec\_epoch in datasets. | Small, 36.0 | 36.0 | | fiscalMonth | String | The month number in fiscal year. Corresponds to \_Month\_Fiscal in datasets. | Small, 36.0 | 36.0 | | fiscalQuarter | String | The quarter number in fiscal year. Corresponds to \_Quarter\_Fiscal in datasets. | Small, 36.0 | 36.0 | | fiscalWeek | String | The week number in fiscal year. Corresponds to \_Week\_Fiscal in datasets. | Small, 36.0 | 36.0 | | fiscalYear | String | The Fiscal year. Corresponds to \_Year\_Fiscal in datasets. | Small, 36.0 | 36.0 | | fullField | String | The full-field field. | Small, 36.0 | 36.0 | | hour | String | The number of hours. If the date contains no hours, value is '0.' Corresponds to \_Hour in datasets. | Small, 36.0 | 36.0 | | minute | String | The number of minutes. If the date contains no minutes, value is '0.' Corresponds to \_Minute in datasets. | Small, 36.0 | 36.0 | | month | String | The month number in calendar year. Corresponds to \_Month is datasets. | Small, 36.0 | 36.0 | | quarter | String | The quarter number in calendar year. Corresponds to \_Quarter in datasets. | Small, 36.0 | 36.0 | | second | String | The number of seconds. If the date contains no seconds, value is '0.' Corresponds to \_Second in datasets. | Small, 36.0 | 36.0 | | week | String | The week number in calendar year. Corresponds to \_Week in datasets. | Small, 36.0 | 36.0 | | year | String | The calendar year. Corresponds to \_Year in datasets. | Small, 36.0 | 36.0 | # Xmd Date Field Input The extended metadata (Xmd) for the formatting of a date field. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | day | String | The day of the month. | Required | 36.0 | | epochDay | String | The number of days that have elapsed since January 1, 1970 (midnight UTC). | Optional | 36.0 | | epochSecond | String | The number of seconds that have elapsed since January 1, 1970 (midnight UTC). Corresponds to \_sec\_epoch in datasets. | Optional | 36.0 | | fiscalMonth | String | The month number in fiscal year. Corresponds to \_Month\_Fiscal in datasets. | Optional | 36.0 | | fiscalQuarter | String | The quarter number in fiscal year. Corresponds to \_Quarter\_Fiscal in datasets. | Optional | 36.0 | | fiscalWeek | String | The week number in fiscal year. Corresponds to \_Week\_Fiscal in datasets. | Optional | 36.0 | | fiscalYear | String | The Fiscal year. Corresponds to \_Year\_Fiscal in datasets. | Optional | 36.0 | | fullField | String | The full-field field. | Optional | 36.0 | | hour | String | The number of hours. If the date contains no hours, value is '0.' Corresponds to \_Hour in datasets. | Required | 36.0 | | minute | String | The number of minutes. If the date contains no minutes, value is '0.' Corresponds to \_Minute in datasets. | Required | 36.0 | | month | String | The month number in calendar year. Corresponds to \_Month is datasets. | Required | 36.0 | | quarter | String | The quarter number in calendar year. Corresponds to \_Quarter in datasets. | Optional | 36.0 | | second | String | The number of seconds. If the date contains no seconds, value is '0.' Corresponds to \_Second in datasets. | Optional | 36.0 | | week | String | The week number in calendar year. Corresponds to \_Week in datasets. | Required | 36.0 | | year | String | The calendar year. Corresponds to \_Year in datasets. | Required | 36.0 | # Xmd Date Input The extended metadata (Xmd) for a date. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | alias | String | The alias of the Date column. | Required | 36.0 | | fields | [XmdDateFieldsInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_date_field_input.htm "The extended metadata (Xmd) for the formatting of a date field.") | The formatting information for the date fields. | Required | 36.0 | | firstDayOfWeek | Integer | Denotes the first day of the week. | Optional | 36.0 | | fiscalMonthOffset | Integer | The offset number of months for the fiscal year in relation to the calendar year. | Optional | 36.0 | | fullyQualifiedName | String | The fully qualified name of the date. | Required | 39.0 | | label | String | The label of the Date column. | Optional | 36.0 | # Xmd Derived Dimension Custom Action Input A custom action for an Xmd derived dimension. Properties XmdDerivedDimensionCustomActionInput inherits properties from the abstract [XmdBaseDimensionCustomActionfInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_dimension_input.htm "The base Xmd dimension for dimensions and derived dimensions."). # Xmd Derived Dimension Input The extended metadata (Xmd) for a derived dimension in an Analytics dataset. Properties XmdDerivedDimensionInput inherits properties from the abstract [XmdBaseDimensionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_dimension_input.htm "The base Xmd dimension for dimensions and derived dimensions."). These base properties appear in XmdDerivedDimensionInput alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`customActions`	XmdDerivedDimensionCustomActionInput[]	A list of custom actions for the derived dimension.	Optional	36.0
`isMultiValue`	Boolean	Indicates whether the derived dimension is multi-value (`true`) or not (`false`).	Optional	36.0
`members`	XmdDerivedDimensionMemberInput[]	Any customizations for specific values of the dataset fields. For example, change the color for this value in a chart to blue. Note When you change the label, the new label only appears in the user interface. You can’t use the label in queries, like a query filter. For this, the best practice is to modify the field values when you create the dataset.	Optional	36.0
`salesforceActions`	XmdDerivedDimensionSalesforceActionInput[]	The actions that appear in the action menu. You can only add actions that are defined in the page layouts for the corresponding Salesforce object. If left blank, Analytics shows all actions.	Optional	36.0

# Xmd Derived Dimension Member Input The extended metadata (Xmd) for a member of a derived dimension in an Analytics dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | color | String | The color for the member. For example, set to “Blue”. | Optional | 36.0 | | label | String | The label for the member. For example, set to “United States”. | Optional | 36.0 | | member | String | The member value. For example, set to “USA”. | Optional | 36.0 | # Xmd Derived Dimension Salesforce Action Input The extended metadata (Xmd) for a Saleforce Action for a derived dimension in an Analytics dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | enabled | Boolean | Indicates whether the action is enabled for a specific dimension. | Required | 36.0 | | name | String | The name of the action. | Required | 36.0 | # Xmd Derived Measure Format Input The extended metadata (Xmd) for the format of a derived measure in an Analytics dataset. Properties

Property Name	Type	Description	Required or Optional	Available Version
`customFormat`	String	When customizing the display, you can add a prefix, suffix, grouping separator, decimal separator, and leading and trailing zeros. You can also configure the number of digits. You can include any characters in prefixes and suffixes, including minus signs or currency symbols. You can use the following symbols to specifying a format. 0. One digit. Use to add leading or trailing 0s. For example, if you apply custom format #,###.00 to 56375, the result is 56,375.00. #. Adds zero or one digit. Use to show digits when applicable. For example, if you apply custom format #,###.## to 56375.56, the result is 56,375.56. .(period). Symbol used as the decimal separator, like in the number 375.56. Analytics currently only supports the decimal symbol (.) as a decimal separator. ,(comma). Symbol used as the grouping separator, like in 56,375. Analytics currently only supports the comma symbol (,) as a grouping separator. Example: ["-$#,###.00$",1]	Optional	38.0
`unitMultiplier`	Double	The multiplier for the unit. The multiplier changes a field’s values by the same factor—like multiplying by 100 to convert decimals to percents. The multiplier must be a positive number.	Optional	36.0

# Xmd Derived Measure Input The extended metadata (Xmd) for a derived measure in an Analytics dataset. Properties XmdDerivedMeasureInput inherits properties from the abstract [XmdBaseMeasureInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_measure_input.htm "The base Xmd measure for measures and derived measures."). These base properties appear in XmdDerivedMeasureInput alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | format | [XmdDerivedMeasureFormatInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_measure_format_input.htm "The extended metadata (Xmd) for the format of a derived measure in an Analytics dataset.") | Format details for the Derived Measure. | Required | 36.0 | # Xmd Dimension The extended metadata (Xmd) for a dimension in an Analytics dataset. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`conditionalFormatting`	ConditionalFormattingProperty	The conditional formatting for a dimension.	Small, 42.0	42.0
`customActions`	XmdDimensionCustomAction	The custom actions linked to this dimension.	Small, 36.0	36.0
`customActionsEnabled`	Boolean	Indicates whether the dimension has custom actions enabled (`true`) or not (`false`).	Small, 36.0	36.0
`defaultAction`	String	The default action for the dimension.	Small, 50.0	50
`field`	String	The field name of the dimension (used in queries).	Small, 36.0	36.0
`label`	String	The display name for the dataset field. Can be up to 40 characters.	Small, 36.0	36.0
`linkTemplate`	String	The URL to open when the user clicks the link in the actions menu. Overrides the default URL link, which is `/{{row.recordIdField}}.` The default finds the Salesforce record with the record ID specified in the `recordIdField` Xmd parameter. Must be 255 characters or less. To open a Salesforce record from a multi-org environment, enter `{{instanceUrl}}` to populate the org URL specified in the `organizations` section of the Xmd. Example: `/{{row.dimensionNameId}}.`	Small, 36.0	36.0
`linkTemplateEnabled`	Boolean	Indicates whether to display the link to open a Salesforce record or URL (`true`) or not (`false`). If set to `false` or not set, the menu doesn't display the Open Record link option.	Small, 36.0	36.0
`linkTooltip`	String	The tooltip that a dashboard viewer sees when they hover over the link in a Analytics lens or dashboard.	Small, 36.0	36.0
`members`	XmdDimensionMember[]	Any customizations for specific values of the dataset fields. For example, for the "Country" field, change the label of the "USA" to "United States." And change the color for this value in a chart to blue. Note When you change the label, the new label only appears in the user interface. You can’t use the label in queries, like a query filter. For this, the best practice is to modify the field values when you create the dataset.	Small, 36.0	36.0
`recordDisplayFields`	String[]	An ordered list of dimensions and measures. These dataset fields are used to help a dashboard viewer identify a Salesforce record when multiple records match the action. For each field, specify its API name. In some instances, a dimension value is associated with multiple IDs and isn’t unique. For example, an opportunity with the name “acme” has multiple opportunity IDs (and records). But the action or link can only be directed to one record.	Small, 36.0	36.0
`recordIdField`	String	The dataset field that contains the record ID of the Salesforce object that you want to perform the action on.	Small, 36.0	36.0
`recordOrganizationIdField`	String	The record organization ID for this dimension.	Small, 36.0	36.0
`salesforceActions`	XmdDimensionSalesforceAction" []	The actions that appear in the action menu. You can only add actions that are defined in the page layouts for the corresponding Salesforce object. If left blank, Analytics shows all actions.	Small, 36.0	36.0
`salesforceActionsEnabled`	Boolean	Indicates if the Salesforce actions menu is enabled to appear on the field (`true`) or not (`false`). If set to `false` or not set, the menu doesn't display any actions.	Small, 36.0	36.0
`showInExplorer`	Boolean	Indicates whether the dataset field can be selected from the dashboard designer or explorer when creating dashboards and lenses (`true`) or not (`false`). Even if `showInExplorer` is `false`, the field can still be used for SAQL queries, manually added in JSON, and accessed using the Analytics REST API.	Small, 36.0	36.0

# Xmd Dimension Custom Action The extended metadata (Xmd) for a custom action on an Analytics dataset dimension. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | icon | String | The icon for the custom action. | Small, 36.0 | 36.0 | | method | String | The method for the custom action. | Small, 36.0 | 36.0 | | target | String | The target for the custom action. | Small, 36.0 | 36.0 | | tooltip | String | The tooltip for the custom action. | Small, 36.0 | 36.0 | | url | String | The URL for the custom action. | Small, 36.0 | 36.0 | # Xmd Dimension Custom Action Input A custom action for an Xmd dimension. Properties XmdDimensionCustomActionInput inherits properties from the abstract [XmdBaseDimensionCustomActionfInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_dimension_input.htm "The base Xmd dimension for dimensions and derived dimensions."). # Xmd Dimension Input The extended metadata (Xmd) for a dimension in an Analytics dataset. Properties XmdDimensionInput inherits properties from the abstract [XmdBaseDimensionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_dimension_input.htm "The base Xmd dimension for dimensions and derived dimensions."). These base properties appear in XmdDimensionInput alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`customActions`	XmdDimensionCustomActionInput[]	A list of custom actions for the dimension.	Optional	36.0
`members`	XmdDimensionMemberInput[]	Any member overrides for specific values of the dataset fields. For example, for the "Country" field, change the label of the "USA" to "United States." And change the color for this value in a chart to blue. Note When you change the label, the new label only appears in the user interface. You can’t use the label in queries, like a query filter. For this, the best practice is to modify the field values when you create the dataset.	Optional	36.0
`salesforceActions`	XmdDimensionSalesforceActionInput[]	The actions that appear in the action menu. You can only add actions that are defined in the page layouts for the corresponding Salesforce object. If left blank, Analytics shows all actions.	Optional	36.0

# Xmd Dimension Member The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | color | String | The color for the member. For example, set to “Blue”. | Small, 36.0 | 36.0 | | label | String | The label for the member. For example, set to “United States”. | Small, 36.0 | 36.0 | | member | String | The member value. For example, set to “USA”. | Small, 36.0 | 36.0 | # Xmd Dimension Member Input The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | color | String | The color for the member. For example, set to “Blue”. | Optional | 36.0 | | label | String | The label for the member. For example, set to “United States”. | Optional | 36.0 | | member | String | The member value. For example, set to “USA”. | Optional | 36.0 | # Xmd Dimension Salesforce Action The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enabled | Boolean | Indicates whether the action is enabled for a specific dimension. | Small, 36.0 | 36.0 | | name | String | The name of the action. | Small, 36.0 | 36.0 | # Xmd Dimension Salesforce Action Input The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | enabled | Boolean | Indicates whether the action is enabled for a specific dimension. | Required | 36.0 | | name | String | The name of the action. | Required | 36.0 | # Xmd Input The extended metadata (Xmd) for an Analytics dataset version. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dataset | [XmdDatasetInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dataset_input.htm "The extended metadata (Xmd) for an Analytics dataset.") | Locale-specific information about the Dataset represented by this Xmd. | Optional | 36.0 | | dates | [XmdDateInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_date_input.htm "The extended metadata (Xmd) for a date.")\[\] | A list of dates with formatting information. | Optional | 36.0 | | derivedDimensions | [XmdDerivedDimensionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_dimension_input.htm "The extended metadata (Xmd) for a derived dimension in an Analytics dataset.")\[\] | A list of derived dimensions with formatting information. | Optional | 36.0 | | derivedMeasures | [XmdDerivedMeasureInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_derived_measure_input.htm "The extended metadata (Xmd) for a derived measure in an Analytics dataset.")\[\] | A list of derived measures with formatting information. | Optional | 36.0 | | dimensions | [XmdDimensionInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_dimension_input.htm "The extended metadata (Xmd) for a dimension in an Analytics dataset.")\[\] | A list of dimensions with formatting information. | Optional | 36.0 | | measures | [XmdMeasureInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_measure_input.htm "The extended metadata (Xmd) for a measure in an Analytics dataset.")\[\] | A list of measures with formatting information. | Optional | 36.0 | | organizations | [XmdOrganizationInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_organization_input.htm "The extended metadata (Xmd) for an organization in an Analytics dataset.")\[\] | A list of organizations for multi-organization support. | Optional | 36.0 | | showDetailsDefaultFields | String\[\] | An ordered list of dimensions and measures. Represents the default order to show them in the UI. | Optional | 36.0 | #### See Also - [Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm "Returns the extended metadata (Xmd) for a version of a dataset and updates the user Xmd file.") # Xmd List Resource Returns a list of Xmd resources for a version of a dataset. This list is for main, system, and user Xmd types. To view asset type Xmds, refer to the [Asset Xmd API resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_asset.htm "Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard."). ## Resource URL /wave/datasets//versions//xmds ## Formats JSON ## Available Version 36.0 ## Available in Postman To view and test a working example of this resource, see [getXmd](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/request/12721794-05dec041-d761-4b70-a56a-bac8a1d72854?action=share&source=copy-link&creator=26106753 "HTML (New Window)") in Postman. For information about how to authenticate your org with Postman, see the [CRM Analytics Rest API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/crma_rest_api_quick_start.htm "Connect to a Salesforce Trailhead org and authenticate. Then make a request to the CRM Analytics REST API in Postman, and look at the response."). ## HTTP Methods GET ## GET Response Body [Xmd Metadata Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_metadata_collection.htm "A collection of Analytics Xmd metadata.") ## 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 Measure The extended metadata (Xmd) for a measure in an Analytics dataset. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | conditionalFormatting | [ConditionalFormattingProperty](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_conditional_formatting_property.htm "The extended metadata (Xmd) for a property in the conditional formatting for an Analytics dataset dimension or measure.") | The conditional formatting for the measure. | Small, 42.0 | 42.0 | | currencySettings | [XmdCurrencySettings](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_currency_settings.htm "The extended metadata (Xmd) for currency settings of a currency field.") | The currency settings for the currencies supported for a currency field. | Small, 57.0 | 57.0 | | field | String | The identifier (API name) for the dataset field. | Small, 36.0 | 36.0 | | format | [XmdMeasureFormat](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_measure_format.htm "The extended metadata (Xmd) for the format of a measure in an Analytics dataset.") | The format details for the measure. | Small, 36.0 | 36.0 | | label | String | The display name for the dataset field. Can be up to 40 characters. For example, “Sales Amount". | Small, 36.0 | 36.0 | | showInExplorer | Boolean | Indicates whether the dataset field can be selected from the dashboard designer or explorer when creating dashboards and lenses (true) or not (false). Even if showInExplorer is false, the field can still be used for SAQL queries, manually added in JSON, and accessed using the Analytics REST API. | Small, 36.0 | 36.0 | # Xmd Measure Format The extended metadata (Xmd) for the format of a measure in an Analytics dataset. Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`customFormat`	String	When customizing the display, you can add a prefix, suffix, grouping separator, decimal separator, and leading and trailing zeros. You can also configure the number of digits. You can include any characters in prefixes and suffixes, including minus signs or currency symbols. You can use the following symbols to specifying a format. 0. One digit. Use to add leading or trailing 0s. For example, if you apply custom format #,###.00 to 56375, the result is 56,375.00. #. Adds zero or one digit. Use to show digits when applicable. For example, if you apply custom format #,###.## to 56375.56, the result is 56,375.56. .(period). Symbol used as the decimal separator, like in the number 375.56. Analytics currently only supports the decimal symbol (.) as a decimal separator. ,(comma). Symbol used as the grouping separator, like in 56,375. Analytics currently only supports the comma symbol (,) as a grouping separator. Example: ["-$#,###.00$",1]	Small, 36.0	36.0
`delimiters`	NumericSeparators	The separators for the thousands and decimal places in the format.	Small, 48.0	48.0
`unitMultiplier`	Double	The multiplier for the unit. The multiplier changes a field’s values by the same factor—like multiplying by 100 to convert decimals to percents. The multiplier must be a positive number.	Small, 36.0	36.0

# Xmd Measure Format Input The extended metadata (Xmd) for the format of a measure in an Analytics dataset. Properties

Property Name	Type	Description	Required or Optional	Available Version
`customFormat`	String	When customizing the display, you can add a prefix, suffix, grouping separator, decimal separator, and leading and trailing zeros. You can also configure the number of digits. You can include any characters in prefixes and suffixes, including minus signs or currency symbols. You can use the following symbols to specifying a format. 0. One digit. Use to add leading or trailing 0s. For example, if you apply custom format #,###.00 to 56375, the result is 56,375.00. #. Adds zero or one digit. Use to show digits when applicable. For example, if you apply custom format #,###.## to 56375.56, the result is 56,375.56. .(period). Symbol used as the decimal separator, like in the number 375.56. Analytics currently only supports the decimal symbol (.) as a decimal separator. ,(comma). Symbol used as the grouping separator, like in 56,375. Analytics currently only supports the comma symbol (,) as a grouping separator. Example: ["-$#,###.00$",1]	Optional	38.0
`unitMultiplier`	Double	The multiplier for the unit. The multiplier changes a field’s values by the same factor—like multiplying by 100 to convert decimals to percents. The multiplier must be a positive number.	Optional	36.0

# Xmd Measure Input The extended metadata (Xmd) for a measure in an Analytics dataset. Properties XmdMeasureInput inherits properties from the abstract [XmdBaseMeasureInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_base_measure_input.htm "The base Xmd measure for measures and derived measures."). These base properties appear in XmdMeasureInput alongside the properties defined explicitly in the following table. | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | format | [XmdMeasureFormatInput](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_measure_format_input.htm "The extended metadata (Xmd) for the format of a measure in an Analytics dataset.") | The format details for the measure. | Required | 36.0 | # Xmd Metadata The metadata for an Analytics Xmd. ## Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	ConnectWaveXmdTypeEnum	The type of Xmd. Values are: `asset` `main` `system` `user`	Small, 36.0	36.0
`url`	String	The location of this Xmd.	Small, 36.0	36.0

# Xmd Metadata Collection A collection of Analytics Xmd metadata. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | url | String | The location of the Xmd collection. | Small, 36.0 | 36.0 | | xmds | [XmdMetadata](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd_metadata.htm "The metadata for an Analytics Xmd.")\[\] | The list of Xmd resources. | Small, 36.0 | 36.0 | #### See Also - [Xmd List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmds.htm "Returns a list of Xmd resources for a version of a dataset. This list is for main, system, and user Xmd types. To view asset type Xmds, refer to the Asset Xmd API resource.") # Xmd Organization The extended metadata (Xmd) for an organization in an Analytics dataset. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID of the org. | Small, 36.0 | 36.0 | | instanceUrl | String | The org’s My Domain login URL in the format https://MyDomainName.my.salesforce.com. | Small, 36.0 | 36.0 | | label | String | The display name for the Salesforce org. Can be up to 40 characters. | Small, 36.0 | 36.0 | # Xmd Organization Input The extended metadata (Xmd) for an organization in an Analytics dataset. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | id | ID | The ID of the org. | Required | 36.0 | | instanceUrl | String | The org’s My Domain login URL in the format https://MyDomainName.my.salesforce.com. | Required | 36.0 | | label | String | The display name for the Salesforce org. Can be up to 40 characters. | Optional | 36.0 | # Xmd Resource Returns the extended metadata (Xmd) for a version of a dataset and updates the user Xmd file. ## Resource URL /wave/datasets//versions//xmds/main /wave/datasets//versions//xmds/system /wave/datasets//versions//xmds/user For full details on Xmd, refer to the [Analytics Extended Metadata (Xmd) Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_xmd.meta/bi_dev_guide_xmd/bi_xmd_intro.htm). ## Formats JSON ## Available Version 36.0 ## Available Components - LWC — [lightning/analyticsWaveApi getXmd()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-xmd.html) - LWC — [lightning/analyticsWaveApi updateXmd()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-analytics-update-xmd.html) ## HTTP Methods GET PUT (on Xmd User type only) ## GET Response Body [Xmd](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd.htm "The extended metadata (Xmd) for an Analytics dataset version.") ## PUT Request Body [Xmd Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_xmd_input.htm "The extended metadata (Xmd) for an Analytics dataset version.") The following JSON shows a PUT request to update measures in the User Xmd. The PUT request cannot be used to update System or Main Xmd types. { "measures" : \[ { "conditionalFormatting" : { }, "field" : "LastModifiedDate\_day\_epoch", "format" : { "delimiters" : { } }, "label" : "LastModDate\_day\_epoch", "showInExplorer" : true }, { "conditionalFormatting" : { }, "field" : "LastModifiedDate\_sec\_epoch", "format" : { "delimiters" : { } }, "label" : "LastModDate\_sec\_epoch", "showInExplorer" : true } \] } ## PUT Response Body [Xmd](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_xmd.htm "The extended metadata (Xmd) for an Analytics dataset version.") # Xmd Resources Manages Xmds for Analytics datasets and assets. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Xmd List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmds.htm "Returns a list of Xmd resources for a version of a dataset. This list is for main, system, and user Xmd types. To view asset type Xmds, refer to the Asset Xmd API resource.") | Returns a collection of Xmd resources for a version of a dataset. This collection is for main, system, and user Xmd types. | GET | /wave/datasets//versions//xmds | | [Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm "Returns the extended metadata (Xmd) for a version of a dataset and updates the user Xmd file.") | Returns the extended metadata (XMD) for a version of a dataset and updates the user XMD file. | GET PUT | /wave/datasets//versions//xmds/ | | [Asset Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_asset.htm "Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard.") | Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard. | GET | /wave/assets//xmds/asset | | [Data Cloud Objects Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_data_cloud_objects.htm "Returns and updates the extended metadata (XMD) that is associated with a Data 360 object, data model objects (DMO), data lake objects (DLO), and Calculated Insight Objects (CIO).") | Returns and updates the extended metadata (Xmd) that is associated with a Data 360 object, data model objects (DMO), data lake objects (DLO), and Calculated Insight Objects (CIO). | GET | /analytics/data-cloud-objects//extended-metadata | - **[Xmd List Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmds.htm)** Returns a list of Xmd resources for a version of a dataset. This list is for main, system, and user Xmd types. To view asset type Xmds, refer to the [Asset Xmd API resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_asset.htm "Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard."). - **[Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm)** Returns the extended metadata (Xmd) for a version of a dataset and updates the user Xmd file. - **[Asset Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_asset.htm)** Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard. - **[Data Cloud Objects Xmd Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_data_cloud_objects.htm)** Returns and updates the extended metadata (XMD) that is associated with a Data 360 object, data model objects (DMO), data lake objects (DLO), and Calculated Insight Objects (CIO).