Bi Dev Guide Rest

• Authenticate to Your Trailhead Playground Org: After configuring the connected app, you must authorize your user with the connected app.
• 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.
• Configure Your Trailhead Org: To configure your Trailhead org, set up Cross-Origin Resource Sharing (CORS) and a connected app.CORS allows code running in a web browser to communicate with Salesforce from a specific origin. To add the URL patterns for Postman:To set up your connected app:
• 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.
• 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.
• Analytics REST API Appendices: Use these appendices when working with enums and other shared resources.
• Analytics REST API Enums: Enums specific to the /wave namespace
• CRM Analytics REST API Examples: Use CRM Analytics REST API examples to perform tasks.
• CRM Analytics REST Resources: REST API resources are sometimes called endpoints.
• Action Input: The action for a rule or macro to perform during a JSON transformation.
• Advanced Property Value Input: An advanced property name and value pair.
• Analytics App Setting Collection Input: The collection of Analytics app settings.
• Analytics App Setting Input: A setting for an Analytics app.
• Analytics Asset Collection Query Input: The query parameters used to request a collection of Analytics assets.
• Analytics Asset Filter Input: A filter for the Analtyics asset collection parameters.
• Annotation Input: An Analytics annotation.
• Asset Archival Input: The assets to archive or restore, and the target archival state.
• Asset Archival Reference Input: A reference to a single CRM Analytics asset to archive or restore.
• Asset Reference Input: An Analytics asset reference.
• Asset Revert History Input: The Analytics asset history to use for a revert request.
• Auto-Install App Configuration Input: The configuration for an auto-install app.
• Auto-Install Configuration Input: The configuration for a auto-install app.
• Auto-Install Request Insert Input: The insert for an auto-install request.
• Auto-Install Request Update Input: The update for an auto-install request.
• Base Asset Input: The base Analytics asset input.
• Base Asset Reference Input: The base Analytics asset.
• Base Auto-Install Request Input: The base auto-install request input.
• Base Notification Action Configuration Input: The base Analytics notification action configuration.
• Base Subscription Input: The base subscription request input.
• Base Wave Folder Input: The base Analytics folder asset.
• Collaboration Room Notification Recipient Input: The Slack recipient of a notification.
• Collection Subscription Source Input: The collection subscription source.
• Component Saved View Input: The saved view for an Analytics component.
• Component Saved View State Input: The state for an Analytics component saved view.
• Conditional Formatting Property Input: A property for conditional formatting of Xmd dimensions and measures.
• Constant Input: The definition of a constant for JSON transformation rules.
• Daily Schedule Input: Specify a daily schedule for an Analytics asset.
• Daily Scheduled Item Input: The daily schedule for a data refresh.
• Dashboard Input: An Analytics dashboard.
• Dashboard Saved View Data Source State Input: The data source state for an Analytics dashboard saved view.
• Dashboard Saved View Filter Input: A filter for an Analytics dashboard saved view.
• Dashboard Saved View Input: A saved view for an Analytics dashboard.
• Dashboard Saved View State Input: The state for an Analytics dashboard saved view.
• Dashboard Saved View Step Metadata Input: The step metadata for an Analytics dashboard saved view.
• Dashboard Saved View Step State Input: The step state for an Analytics dashboard saved view.
• Dashboard Subscription Source Input: The dashboard subscription source.
• Dashboard Widget Item Input: The base dashboard widget item.
• Data Cloud Extended Metadata Input: The extended metadata (Xmd) for a Data 360 object data source for Analytics.
• Data Cloud Field Extended Metadata Input: The extended metadata (Xmd) for a field in Data 360 object.
• Data Cloud Field Value Input: A customized display value for a data object field.
• Data Connector Input: An Analytics data connector.
• Data Connector Property Input: A property for an Analytics data connector.
• Dataflow Input: An Analytics dataflow.
• Dataflow Job Input: An Analytics dataflow job.
• Dataset Input: An Analytics dataset.
• Dataset Version Input: A specific version of an Analytics dataset.
• Event Based Schedule Input: Specify an event-driven schedule for an Analytics asset.
• Featured Assets Input: A feaatured assets for an Analytics app.
• Geo Data Input: The geo data used by a map.
• Hourly Schedule Input: Specify a sub-daily schedule for an Analytics asset.
• Json Transformation Input: The JSON request to perform transformation rules on.
• Lens Input: An Analytics lens.
• Lens State Input: The state for an Analytics lens.
• License Attributes Input: The Analytics license attributes.
• Live Connection Input: The connection details of an Analytics live dataset.
• Macro Input: A macro to use for a JSON transformation rule.
• Map Bounding Box Input: A bounding box of a map..
• Map Input: A map for an Eclair chart.
• Mapped SDM Input: A mapped Tableau Next semantic model.
• Minutely Schedule Input: Specify a sub-hourly schedule for an Analytics asset.
• Monthly Relative Schedule Input: Specify a monthly schedule for an Analytics asset where the day are relative to their location in the week.
• Monthly Specific Schedule Input: Specify a monthly schedule for an Analytics asset where the days are fixed by numerical date.
• Notification Action Input: A notification action for an Analytics subscription.
• Post To Slack Notification Action Configuration Input: The notification action configuration for posting to Slack.
• Replicated Dataset Input: An Analytics replicated dataset, also know as a connected object.
• Replicated Field Collection Input: A collection of fields for an Analytics replicated dataset, also known as a connected object.
• Replicated Field Input: A field for an Analytics replicated dataset, also known as a connected object.
• Restore Dataset Version Input: A specific version to restore an Analytics dataset to.
• Rule Definition Input: A rule definition to use for a JSON transformation.
• Rule Input: A rule for a JSON Transformation rule definition.
• SAQL Query Input: An Analytics query written in SAQL or SQL.
• Schedule Details Input: The base Analytics schedule details.
• Schedule Input: A schedule on which to execute some type of Analytics asset.
• Scheduled Item Input: The base schedule for a data refresh.
• Scheduled Time Input: The base schedule for a data refresh.
• Scheduled Timezone Input: The information for a schedule time zone.
• Send To Email Notification Action Configuration Input: The notification action configuration for sending an email.
• Slack Reference Input: The reference for a Slack entity.
• Source Details Input: The abstract source details for a subscription.
• Source Object Data Input: The request to retrieve data from a source object given a list of fields and advanced properties.
• Subscription Daily Schedule Input: The daily schedule on which to execute an Analytics subscription.
• Subscription Input: An Analytics subscription.
• Subscription Schedule Input: An Analytics subscription input.
• Subscription Source Input: The subscription source.
• Subscription Weekly Schedule Input: The weekly schedule on which to execute an Analytics subscription.
• Subscription Widget Input: An Analytics widget subscription inherits properties from the base Dashboard Widget Item Input.
• Template Input: An Analytics template.
• Template Options Input: The template options used to upgrade a templated Analytics app.
• Template Validate Input: The input to validate an Analytics template.
• Time Input: The time at which something should happen, usually in relation to an Analytics schedule.
• Trended Report Input: An Analytics trended report.
• Typed Asset Reference Input: A typed Analytics asset reference.
• Visual Parameters Input: A visual parameters for an Analytics watchlist item.
• Watchlist Input: An Analytics watchlist.
• Watchlist Item Input: An Analytics watchlist item.
• Watchlist Item Metadata Input: The metadata for an Analytics watchlist item.
• Watchlist Schedule Input: An Analytics watchlist schedule.
• Wave Collection Input: A collection of Analytics resources.
• Wave Collection Item Bulk Add Input: Bulk items to add to a collection of Analytics resources.
• Wave Collection Item Input: An item in a collection of Analytics resources.
• Wave Collection Item List Input: A list of items in a collection of Analytics resources.
• Wave Collection Pin Input: The pinning rules for an Analytics collection.
• Wave Folder Input: An Analytics folder. This implements BaseWaveFolderInput.
• Wave Folder Schedule Input: An Analytics folder schedule.
• Wave Folder Share Input: An Analytics folder sharing rule.
• Wave Folder Template Input: A templated Analytics folder. This implements BaseWaveFolderInput.
• Weekly Schedule Input: Specify a weekly schedule for an Analytics asset.
• Weekly Scheduled Item Input: The weekly schedule for a data refresh.
• Widget Subscription Source Input: The widget subscription source.
• Base Xmd Dimension Custom Action Input: The base custon action for an Xmd dimension.
• Base Xmd Dimension Input: The base Xmd dimension for dimensions and derived dimensions.
• Base Xmd Measure Input: The base Xmd measure for measures and derived measures.
• Xmd Currency Settings Input: The extended metadata (Xmd) for currency settings of a currency field.
• Xmd Dataset Input: The extended metadata (Xmd) for an Analytics dataset.
• Xmd Date Field Input: The extended metadata (Xmd) for the formatting of a date field.
• Xmd Date Input: The extended metadata (Xmd) for a date.
• Xmd Derived Dimension Custom Action Input: A custom action for an Xmd derived dimension.
• Xmd Derived Dimension Input: The extended metadata (Xmd) for a derived dimension in an Analytics dataset.
• Xmd Derived Dimension Member Input: The extended metadata (Xmd) for a member of a derived dimension in an Analytics dataset.
• Xmd Derived Dimension Salesforce Action Input: The extended metadata (Xmd) for a Saleforce Action for a derived dimension in an Analytics dataset.
• Xmd Derived Measure Format Input: The extended metadata (Xmd) for the format of a derived measure in an Analytics dataset.
• Xmd Derived Measure Input: The extended metadata (Xmd) for a derived measure in an Analytics dataset.
• Xmd Dimension Custom Action Input: A custom action for an Xmd dimension.
• Xmd Dimension Input: The extended metadata (Xmd) for a dimension in an Analytics dataset.
• Xmd Dimension Member Input: The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset.
• Xmd Dimension Salesforce Action Input: The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset.
• Xmd Input: The extended metadata (Xmd) for an Analytics dataset version.
• Xmd Measure Format Input: The extended metadata (Xmd) for the format of a measure in an Analytics dataset.
• Xmd Measure Input: The extended metadata (Xmd) for a measure in an Analytics dataset.
• Xmd Organization Input: The extended metadata (Xmd) for an organization in an Analytics dataset.
• Actions Resource: Returns the Salesforce actions available for the user in Analytics. The entityId is the user id.
• Analytics Asset Resource: Returns an Analytics asset by ID.
• Analytics Assets Collection Resource: Returns a collection of Analytics assets.
• Asset Archival Resource: Archives or restores one or more CRM Analytics assets by moving them to or from the Recycle Bin.
• Analytics Assets Resources: Query Analytics assets using parameters for a collections or query a single asset by ID.
• Annotations List Resource: Returns a list of annotations and creates an annotation.
• Annotation Resource: Returns an asset's annotations and updates an annotation.
• Annotation Resources: Annotate Analytics dashboard widgets with comments posted in the dashboard and in Chatter.
• 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.
• Asset Files List Resource: Returns a collection of asset files for an asset and creates an asset file.
• Asset File Resource: Returns a preview file for an asset and updates the file.
• 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
• 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.
• Auto-Install Request Resource: Returns an auto-install request for an Analytics embedded app, updates, and deletes 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.
• Collections List Resource: Returns a list of collections or creates a collection. Each collection contains Analytics resource items.
• Collections Bulk Items Resource: Add items in bulk to the collection.
• Collections Resource: Returns, updates, or deletes a collection. Each collection contains Analytics resource items.
• Collections Item Resource: Deletes an item from the collection.
• Collections Items List Resource: Returns a list of Analytics collection items and creates or updates the collection item list.
• Collection Resources: Analytics collections let users manage their own groups of items and personalize their Analytics Studio home page.
• Features Configuration Resource: The Analytics features that are available to a user.
• 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.
• 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.
• Dashboards List Resource: Returns a list of Analytics dashboard or creates a dashboard.
• Dashboard Resource: Returns, deletes, or updates the dashboard with the specified ID or API name.
• Dashboard Bundle Resource: Returns or updates the dashboard bundle with the specified ID or API name.
• Dashboard Histories Resource: Returns the dashboard histories with the specified ID or API name.
• 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.
• 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.
• Dashboard Saved Views List Resource: Returns a list of dashboard saved views or creates a single view.
• Dashboard Saved View Resource: Returns, deletes, and updates a dashboard saved view.
• 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.
• Dashboard Image Resource: Returns a dashboard’s image as an asset reference.
• 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.
• Data Connectors List Resource: Returns a collection of Analytics connectors and creates an Analytics connector.
• 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.
• Data Connector Source Object Fields Resource: Returns a list of source fields for a particular source object.
• Data Connector Resource: Returns Analytics connector properties and updates or deletes Analytics connectors.
• Data Connector Ingest Resource: 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: Returns a list of all the source objects that are present under the specified Analytics connection.
• 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.
• Data Connector Status Resource: Tests the status of an external Analytics connector. This API doesn't work to test a local Salesforce connector.
• 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.
• Data Connector Types Resource: Returns a collection of Analytics connector types.
• Dataflow Jobs List Resource: Returns a list of dataflow jobs and starts a new dataflow job. Includes standard dataflows and recipes.
• Dataflow Job Resource: Returns a dataflow job and stops a current dataflow job. Includes standard dataflows and recipes.
• 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.
• 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.
• Dataflow Job Resources: Dataflow jobs are used to sync data for data prep recipes and standard dataflows.
• 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.
• 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.
• 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.
• Dataflows List Resource: Returns a collection of dataflows.
• Dataflow Resource: Returns a dataflow. Reverts a dataflow to a previous version.
• Dataflow Resources: Dataflows are used to prepare data for Analytics, creating one or more datasets using transformations to manipulate the data.
• Dataset Resource: Returns, deletes, or updates a dataset with the specified ID or API name.
• Datasets List Resource: Returns a collection of Analytics dataset and creates a dataset.
• Dataset Versions List Resource: Returns a list of dataset versions for a particular dataset or creates a version.
• Dataset Version Resource: Returns an Analytics dataset version or updates the version predicate.
• Dataset Version File Resource: Provides access to the binary content of the dataset version file.
• Dataset Resources: Manage Analytics dataset and dataset versions.
• Dependencies Resource: Returns the dependencies for an asset.
• Charts Geodata List Resource: Returns a collection of geodata definitions and creates a geodata definition.
• Charts Geodata Resource: Returns a geodata definition, updates, or delete a geodata definition.
• Charts Geodata File List Resource: Return the binary file associated with a geodata definition.
• Charts Maps List Resource: Returns a list of maps or creates a map.
• Charts Maps Resource: Returns, updates, or deletes a specific map.
• Eclair Chart Resources: Eclair charts render maps and geodata in Analytics dashboards.
• 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.
• Folder Resource: Returns, deletes, updates, or replaces 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.
• Folder Settings Resource: Returns or updates the settings for an Analytics app or folder with the specified ID.
• Folder Resources: Analytics folders represent apps, a collection of assets. Folders can be created by users or by 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.
• Lenses List Resource: Returns a list of Analytics lenses or creates a lens.
• Lens Resource: Returns, deletes, or updates the lens with the specified ID or API name.
• Lens Bundle Resource: Returns or updates the lens bundle with the specified ID or API name.
• Lens File Metadata Resource: Returns or creates the lens file metadata with the specified ID or API name.
• Lens File Resource: Returns or updates a file that is part of 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.
• Limits Resource: The Analytics limits for the Salesforce org.
• Query Resource: Executes a query written in Salesforce Analytics Query Language (SAQL) or SQL for CRM Analytics.
• Recipe Resources: Recipes are used to prepare data, creating a dataset using transformations to manipulate the data.
• Replicated Datasets List Resource: Returns a list of replicated datasets, also know as connected objects.
• 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.
• Replicated Dataset Fields Resource: Retrieves a list of fields for the specified connected object.
• 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.
• Schedule Resource: Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync.
• 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).
• 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.
• Subscriptions List Resource: Returns a list of subscriptions or creates a subscription schedule.
• Subscription Resources: Manages subscriptions for Analytics dashboards.
• Subscription Resource: Retrieve, update, or delete a subscription.
• Subscription Layout Resource: Update the grid layout for a subscription.
• Subscription Widgets Resource: Create a subscription for a widget.
• Subscription Widget Resource: Update or delete a subscription for a widget.
• Templates List Resource: Returns a list of Analytics templates, or creates a template.
• Template Configuration Resource: Returns the configuration of an Analytics template.
• Template Resource: Returns, deletes, or updates an Analytics template.
• Template Release Notes Resource: Returns the release notes for a single Analytics Template.
• Template Lint Resource: Returns, deletes, or creates the lint value for an Analytics template.
• Template Resources: Manage Analytics templates, template configuration, and template release notes.
• Template Validation Resource: Validates an Analytics template for org readiness.
• Trended Reports List Resource: Returns a list of trending reports or creates a trending report.
• Trended Report Resources: Manage Analytics trending reports.
• Trended Reports Resource: Returns, deletes, or updates a trending report.
• Unsupported Features Resource: Returns the unsupported features for CRM Analytics in the current datacenter environment.
• Watchlist Resource: Return, create, and update a watchlist.
• Watchlist Item Resource: Return, update, and delete a watchlist item.
• Watchlist Schedules Resource: Create a watchlist schedule.
• Watchlist Schedule Resource: Update a watchlist schedule.
• Watchlist Resources: Manages watchlists for Analytics dashboards.
• Wave Resource: Lists the top-level resources available for Analytics.
• Asset Xmd Resource: Returns the extended metadata (Xmd) that is associated with an asset, like a dashboard.
• 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).
• Xmd Resource: Returns the extended metadata (Xmd) for a version of a dataset and updates the user Xmd file.
• Xmd Resources: Manages Xmds for Analytics datasets and assets.
• 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.
• Abstract Field: The base definition of a dataset field.
• Abstract Lint Item: The base readiness task for an Analytics template.
• Action: A Salesforce action.
• Action Collection: A collection of Salesforce actions available to the user.
• Advanced Property: An advanced property is a replication property for a data connector source object.
• Advanced Property Value: An advanced property name and value pair.
• Analysis Configuration Outcome: The outcome for an Einstein Discovery story.
• Analytics App Setting: A setting for an Analytics app.
• Analytics App Setting Collection: The collection of Analytics app settings.
• Analytics Asset: An Analytics asset.
• Analytics Asset Collection: A collection of Analytics assets.
• Analytics Data Asset File: A file used for preview of an Analytics data asset.
• Annotation: An Analytics annotation.
• Annotation Collection: A collection of annotations.
• App Details: The app details for a template configuration wizard page.
• App Log: The app log for app creation and updates.
• Array Type: The array type of an Analytics template variable.
• Asset Archival Item Result: The archival status and result for a single requested asset.
• Asset Archival Result: The result of an asset archive or restore request.
• Asset History: The history of an Analytics asset.
• Asset History Collection: A collection of asset histories.
• Asset Publisher: The publisher of an Analytics asset.
• Asset Publishers Collection: A collection of asset publishers.
• Asset Reference: An Analytics asset reference.
• Auto-Install App Configuration: The configuration for a auto-install app.
• Auto-Install Configuration: The configuration for a auto-install request.
• Auto-Install Request: A auto-install request.
• Auto-Install Request Collection: A collection of auto-install requests.
• Base Asset Reference: The base Analytics asset.
• Base Collection Reference: The base Analytics collection.
• Base File: The base Analytics file.
• Base Notification Action Configuration: The base Analytics notification action configuration.
• Base Object Type: The base type for an Analytics template object variable.
• Base Templated Asset: A base Analytics asset created from a template.
• Base Wave Asset: The base Analytics asset.
• Boolean Type: The boolean type of an Analytics template variable.
• Bounding Box: A bounding box of a map.
• Calculated Insight Field Type: The calculated insight field type of an Analytics template variable.
• Calculated Insight Type: The calculated insight type of an Analytics template variable.
• Collaboration Room Notification Recipient: The Slack recipient of a notification.
• Collection Pin: The pinning rules for an Analytics collection.
• Collection Subscription Source: The collection subscription source.
• Compact Form Column: A compact form column.
• Compact Form Filter: A compact form filter.
• Compact Form Join: A compact form join for q query.
• Compact Form Join Object: A compact form join object for q query.
• Compact Form Source: A compact form source for a query.
• Component Saved View: A state for the saved view of an Analytics component.
• Component Saved View State: A state for the saved view of an Analytics component.
• Conditional Formatting Property: The extended metadata (Xmd) for a property in the conditional formatting for an Analytics dataset dimension or measure.
• Configuration Page Layout: The configuration page layout for a template configuration wizard page.
• Connection Property: A property used to connect to an Analytics data connector.
• Connection Property Value: A connection property name and value pair.
• Connector Type: The connector type of an Analytics template variable.
• Connectors Stats: The statistics information for the Analytics connectors.
• Contextual Source Asset: A contextual representation of an Analytics dashboard.
• Coverage Job: The output of a user coverage request.
• Custom Component Layout: A custom component layout for an Analytics template wizard page.
• Custom Component Layout Variable: A variable for the custom component layout to pass to the LWC.
• Daily Schedule: Specify a daily schedule for an Analytics asset.
• Daily Scheduled Item: The daily schedule for a data refresh.
• Dashboard: An Analytics dashboard.
• Dashboard Collection: A collection of Analytics dashboards.
• Dashboard Context Asset: A contextual representation of an embedded Analytics dashboard.
• Dashboard Context Location: A location of an Analytics embedded dashboard.
• Dashboard Saved View: A saved view for an Analytics dashboard.
• Dashboard Saved View Collection: A collection of Analytics dashboard saved views.
• Dashboard Saved View Data Source State: A data source state for the saved view of an Analytics dashboard.
• Dashboard Saved View Filter: A filter for the saved view of an Analytics dashboard.
• Dashboard Saved View Initial: The initial saved view of an Analytics dashboard.
• Dashboard Saved View State: A state for the saved view of an Analytics dashboard.
• Dashboard Saved View Step Metadata: The step metadata for the saved view of an Analytics dashboard.
• Dashboard Saved View Step State: A step state for the saved view of an Analytics dashboard.
• Dashboard Snapshot Item: An Analytics dashboard snapshot item.
• Dashboard Snapshot Item Data Row: An Analytics dashboard snapshot item data row.
• Dashboard Snapshot Item Last Run: The Analytics dashboard snapshot item last run information.
• Dashboard Snapshot Item Result: An Analytics dashboard snapshot item.
• Dashboard Snapshot Item Source Dashboard: The dashboard source for a dashboard snapshot item.
• Dashboard Subscription Source: The dashboard subscription source.
• Data Cloud Extended Metadata Output: The extended metadata (Xmd) for a Data 360 object data source for Analytics.
• Data Cloud Field Extended Metadata: The extended metadata (Xmd) for a field in Data 360 object.
• Data Cloud Field Value: A customized display value for a data object field.
• Data Connector: An Analytics data connector.
• Data Connector Collection: A collection of Analytics data connectors.
• Data Connector Status: The status for an Analytics data connector.
• Data Connector Type: An Analytics data connector type.
• Data Connector Type Collection: A collection of Analytics data connector types.
• Data Lake Object Field Type: The data lake object field type of an Analytics template variable.
• Data Lake Object Type: The data lake object type of an Analytics template variable.
• Data Model Object Field Type: The data model object field type of an Analytics template variable.
• Data Model Object Type: The data model object type of an Analytics template variable.
• Dataflow: An Analytics dataflow.
• Dataflow Collection: A collection of Analytics dataflows.
• Dataflow Job: An Analytics dataflow job.
• Dataflow Job Collection: A collection of Analytics dataflow jobs.
• Dataflow Job Node: A node in a dataflow job.
• Dataflow Job Node Collection: The collection of nodes for an Analytics dataflow job.
• Dataflow Job Node Stage: A stage in a dataflow job node.
• Dataflow Job Node Stage Collection: The collection of stages for an Analytics dataflow job node.
• Dataflow Job Node Stage Parents: The parent information for a dataflow job node stage.
• Dataflow Node: A node in an dataflow job.
• Dataflow Node Collection: The collection of nodes for an Analytics dataflow.
• Dataset: An Analytics dataset.
• Dataset Any Field Type: The dataset generic field type of an Analytics template variable.
• Dataset Collection: A collection of datasets.
• Dataset Coverage: The security coverage for a specific dataset version.
• Dataset Date Type: The date in a dateset type of an Analytics template variable.
• Dataset Dimension Type: The dimension in a dateset type of an Analytics template variable.
• Dataset Measure Type: The measure in a dateset type of an Analytics template variable.
• Dataset Source: The source object used to create a dataset.
• Dataset Type: The dateset type of an Analytics template variable.
• Dataset Version: A specific version of an Analytics dataset.
• Dataset Version Collection: A collection of versions for an Analytics dataset.
• Dataset Version Reference: The dataset version the coverage information applies to.
• Date Time Type: The date time type of an Analytics template variable.
• Dependency: An Analytics asset dependency.
• Dependency Collection: A collection of Analytics asset dependencies.
• Directory Item Collection: A collection of directory items.
• Display Message: The display message for an Analytics template.
• Empty Schedule: Specify an empty schedule for an Analytics asset.
• Event Driven Schedule: Specify an event-driven schedule for an Analytics asset.
• Featured Assets: The featured assets.
• Geo Data: The geo data used by a map.
• Geo Data Collection: A collection of the geo data used by a map.
• Group Box Item: A group box item on a panel for an Analytics template wizard page.
• Guidance Panel: The guidance panel for a template configuration wizard page.
• Header: The header for an Analytics template wizard page.
• Hourly Schedule: Specify an hourly schedule for an Analytics asset.
• Image Asset Reference: A image asset for Analytics.
• Image Item: An image item on a panel for an Analytics template wizard page.
• Job Event: An audit events for a job, like recipe start or dataflow cancelled.
• Job Event Collection: A collection of audit events for jobs, like recipe start or dataflow cancelled.
• Json Transformation: The transformed JSON after processing the transformation rules.
• Layout: The base layout for an Analytics template wizard page.
• Lens: Am Analytics lenses.
• Lens Collection: A collection of Analytics lenses.
• Lens File: A file used to generate a lens.
• Lens Source Asset: A contextual representation of an Analytics lens.
• Lens State: The state for an Analytics lenses.
• License Attributes: The Analytics license attributes.
• Link Asset Destination: A link to an Analytics asset.
• Link Box Item: A link box item on a panel for an Analytics template wizard page.
• Literal Json: A string of JSON content results, usually for a query response.
• Live Connection: The connection details of an Analytics live dataset.
• Macro Definition: A macro definition that is part of a larger macro for a JSON transformation rule.
• Map: A map object.
• Map Collection: A collection of maps.
• Mapped SDM: A mapped Tableau Next semantic model.
• Minutely Schedule: Specify a schedule that runs multiple times an hour for an Analytics asset.
• Monthly Relative Schedule: Specify a schedule that runs monthly on a relative day within the month for an Analytics asset.
• Monthly Specific Schedule: Specify a schedule that runs monthly on a specific day within the month for an Analytics asset.
• Navigation Panel: The navigation panel for a template configuration wizard page.
• Node Row Count: The node row count for an Analytics dataflow job node.
• Notification Action: A notification action for an Analytics subscription.
• Number Type: The number type of an Analytics template variable.
• Numeric Separators: The numeric separators for thousands and decimals, used in formatting.
• Object Coverage: The security coverage for a source object.
• Object Type: The object type of an Analytics template variable.
• Output Source: The output source for an Analytics replicated dataset, also known as a connected object.
• Page: A UI page for an Analytics template.
• Page Layout: The page layout definition for an Analytics template.
• Page Navigation Info: The navigation information for a template configuration wizard page.
• Page Variable: An Analytics variable to display on a UI page.
• Panel: A panel in a column layout for an Analytics template wizard page.
• Panel Item: An item on a panel in a column layout for an Analytics template wizard page.
• Permissions: The user permissions for an Analytics asset.
• Post To Slack Notification Action Configuration: The notification action configuration for posting to Slack.
• Property Condition: A condition where the connection property is visible.
• Property Option: A value option for Select connection properties.
• Query: A query written in SAQL or compact form.
• Replicated Dataset: An Analytics replicated dataset, also know as a connected object.
• Replicated Dataset Collection: A collection of Analytics replicated datasets, also know as connected objects.
• Replicated Field: A field for an Analytics replicated dataset, also known as a connected object.
• Replicated Field Collection: A collection of fields for an Analytics replicated dataset, also known as a connected object.
• Report Source Asset: A contextual representation of a report asset.
• Restore Dataset Version: The message returned for an Analytics data connector ingest request or an Analytics dataset version update request.
• Schedule: A schedule on which to execute some type of Analytics asset job.
• Schedule Details: The base Analytics schedule details, inherited by SubscriptionDailySchedule and SubscriptionWeeklySchedule.
• Scheduled Item: The base schedule for a data refresh.
• Scheduled Time: The base schedule for a data refresh.
• Scheduled Timezone: The information for a schedule time zone.
• Security Predicate: The security predicate for an Analytics dataset.
• Send To Email Notification Action Configuration: The notification action configuration for sending an email.
• Sharing Inheritance: The sharing inheritance for an Analytics dataset.
• Single Column Layout: A single column layout for an Analytics template wizard page.
• Size Limit: The size limit of an Analytics template array type variable.
• Slack Reference: The reference for a Slack entity.
• Snapshot: An Analytics snapshot.
• Sobject Field Type: The sobject field type of an Analytics template variable.
• Sobject Type: The sobject type of an Analytics template variable.
• Source Field: A field for a source object.
• Source Field Collection: A collection of fields for a source object.
• Source Object: A source object for an Analytics data connector.
• Source Object Collection: A collection of source objects for an Analytics data connector.
• Source Object Data: The data retrieved from a source object given a list of fields and advanced properties.
• String Type: The string type of an Analytics template variable.
• Subscription: An Analytics subscription.
• Subscription Collection: A collection of Analytics subscriptions.
• Subscription Daily Schedule: The daily schedule on which to execute an Analytics subscription.
• Subscription Schedule: An Analytics subscription schedule.
• Subscription Source: The base Analytics subscription source.
• Subscription Weekly Schedule: The weekly schedule on which to execute an Analytics subscription.
• Template: An Analytics template.
• Template Collection: A collection of Analytics templates.
• Template Configuration: The configuration for an Analytics Template.
• Template Custom Attributes: The custom attributes or metadata for an Analytics template.
• Template Icons: The icons for an Analytics template.
• Template Lint: The lint score for an Analytics template.
• Template Lint Item: An individual linting task for an Analytics template.
• Template Options: The template options used on the last action performed on a templated Analytics app.
• Template Readiness Item: An individual validation task for an Analytics template.
• Template Release: The release information for an Analytics template.
• Template Release Notes: The release notes for an Analytics template.
• Template Validate: The validation for an Analytics template.
• Text Item: A text item on a panel for an Analytics template wizard page.
• Time: The time at which something should happen, usually in relation to an Analytics schedule.
• Time Zone: The time zone in which something should happen, usually in relation to an Analytics schedule.
• Trended Report: An Analytics trended report.
• Trended Report Collection: A collection of Analytics trended reports.
• Two Column Layout: A two column layout for an Analytics template wizard page.
• Typed Asset Reference: A typed Analytics asset reference.
• UI Configuration: Get the Analytics UI configuration data.
• UI Definition: The UI definition for an Analytics template.
• UI Layout Definition: The UI layout definition for an Analytics template.
• Unsupported Record: The sharing usage of object instances based on Analytics limits.
• Unsupported Record Collection: The collection of specific records that unsupported for sharing inheritance.
• User Collection: Information for a user. Used by the Map representation
• Validation Page Group: An org readiness requirement group on a validation page for a template validation wizard page.
• Validation Page Layout: The validation page layout for a template configuration wizard page.
• Variable Definition: The variable definition for an Analytics template. Specific variable type responses are listed here.
• Variable Item: A variable item on a panel for an Analytics template wizard page.
• Variable Item Tile: A variable item tile for a variable on a template wizard page.
• Variable Type: The abstract type for an Analytics template variable.
• Video Info: Information for describing a particular video.
• Visual Parameters: A visual parameters for an Analytics watchlist item.
• Watchlist: An Analytics watchlist collection.
• Watchlist Snapshot: An Analytics watchlist snapshot collection.
• Wave Analytics Limit: An Analytics limit.
• Wave Analytics Limit Collection: The collection of Analytics limits.
• Wave Asset Bundle: The Analytics asset bundled with the associated metadata.
• Wave Collection: A collection of Analytics resources.
• Wave Collection Item: An item in a collection of Analytics resources.
• Wave Collection Item List: A list of items in a collection of Analytics resources.
• Wave Collection List: A list of Analytics collections.
• Wave Features: The Analytics features enabled for a user.
• Wave File Metadata: The metadata for an Analytics file.
• Wave File Metadata Collection: A collection of the metadata for Analytics files.
• Wave Folder: An Analytics folder.
• Wave Folder Collection: A collection of Analytics folders.
• Wave Folder Schedule: An Analytics folder schedule.
• Wave Folder Share: An Analytics folder sharing rule.
• Wave Unsupported Features: The unsupported Analytics features for the org.
• Wave User: An Analytics user.
• Weekly Schedule: Specify a schedule that runs weekly for an Analytics asset.
• Weekly Scheduled Item: The weekly schedule for a data refresh.
• Widget Subscription Source: The widget subscription source.
• Xmd: The extended metadata (Xmd) for an Analytics dataset version.
• Xmd Currency Settings: The extended metadata (Xmd) for currency settings of a currency field.
• Xmd Dataset: The extended metadata (Xmd) for currency settings of a currency field.
• Xmd Date: The extended metadata (Xmd) for a date.
• Xmd Date Field: The extended metadata (Xmd) for the formatting of date fields.
• Xmd Dimension: The extended metadata (Xmd) for a dimension in an Analytics dataset.
• Xmd Dimension Custom Action: The extended metadata (Xmd) for a custom action on an Analytics dataset dimension.
• Xmd Dimension Member: The extended metadata (Xmd) for a member linked to a dimension in an Analytics dataset.
• Xmd Dimension Salesforce Action: The extended metadata (Xmd) for a Saleforce Action for a dimension in an Analytics dataset.
• Xmd Measure: The extended metadata (Xmd) for a measure in an Analytics dataset.
• Xmd Measure Format: The extended metadata (Xmd) for the format of a measure in an Analytics dataset.
• Xmd Metadata: The metadata for an Analytics Xmd.
• Xmd Metadata Collection: A collection of Analytics Xmd metadata.
• Xmd Organization: The extended metadata (Xmd) for an organization in an Analytics dataset.
• Query CRM Analytics Data with the Query API: Use the CRM Analytics REST API to directly query analytics data using SAQL or SQL queries.
• 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.
• Connect REST API Authorization: Connect REST API uses OAuth to securely identify your application before connecting to Salesforce.
• 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.
• CRM Analytics REST API Overview: You can access CRM Analytics features such as datasets, dashboards, and lenses programmatically using the CRM Analytics REST API.
• 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.
• CRM Analytics REST API Resources Overview: The CRM Analytics REST API provides resources so you can access your CRM Analytics data.
• 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.
• 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.
• 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: Complete these prerequisites before you begin the quick start.
• Set Up Your Postman Collection: Set up Postman to work with the Salesforce CRM Analytics Connect API collection.Configure the desktop Postman app if you haven’t already done so.Fork the main collection for your own use.Authorize your Salesforce Trailhead org for your forked collection.