--- schema_version: "1" id: ca604a7b239afee78b5e8dbe28fed45c863153a6fc7f736fa2a5804805274e5f title: Pulse Methods collection: tableau version: current locale: en-us portal_url: https://docs.salesforce.com/tableau/current/en-us/api/rest_api/REST/rest_api_ref_pulse.md canonical_url: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_pulse.htm source_site: help.tableau.com content_type: documentation content_hash: 887d64a9ee522325ea5c0b39de894a8737121925d47c4d5b9622635685356180 description: With Tableau Pulse, Tableau Cloud users can follow metrics and use guided exploration to understand more about their data --- [Skip to main content](#main-content) # Pulse Methods With Tableau Pulse, Tableau Cloud users can follow metrics and use guided exploration to understand more about their data. In addition to viewing metrics from the Tableau Pulse home page, users can receive digests via Slack or email that include insights into important changes in their data so users can stay up to date. ### Tableau Pulse Overview - A **metric definition** specifies the metadata for all related metrics created using the definition. This includes the data source, measure, time dimension, and which data source dimensions can be filtered by users or programmatically to create related metrics. - Example: A metric definition might specify that the data source is the Superstore sales database, and that the measure to focus on is the aggregation "sum of sales". It could define the filterable dimensions as region and product line, that the time dimension for analysis is order date, and that the favorable direction is for the metric to increase. - A **metric** is the interactive object that users follow and receive updates on. It specifies the values to give the filterable dimensions of the metric's definition and the measurement time period of the metric. - Example: A user or REST request could filter the metric, and its automatically generated insights, based on the West region and product line sold. The insight provided might call out that discounted sales have risen sharply in a region between last quarter and the current one. - A user who follows (has a **subscription** to) a metric can receive digests via email or Slack. Digests can also be viewed in the Metrics home page in the Tableau UI. - A digest provides summary visualizations and text describing the top **insight**s for a metric. It also displays links to further metric details and to suggested follow up questions based on the metric's data and insights. - An **insight** is a data-driven observation about a metric. Tableau automatically generates and ranks insights by usefulness. - An **insight bundle** is a collection of insights for a metric That can be configured to include various elements. For more information and to learn about the UI features related to these methods, see [Create Pulse Metrics](https://help.tableau.com/current/online/en-us/pulse_create_metrics.htm). ### Configuring Pulse insights for a metric You can use Pulse REST API methods to generate an insight bundle for a metric. An insight bundle request specifies the metric being analyzed, the output format (text or HTML), time frame, and additional filters for the insights in the bundle. #### Standard bundle types In the request, you configure the type of insight **bundle** that should be provided for a metric. Types include: - `ban` - Shows the current aggregated value for a metric, period over period change, and the highest ranked insight for each filterable dimension of the metric. - `springboard` - Shows the current value, period over period change, and the highest ranked insight for the metric. - `basic` - Similar to a springboard insight, but data is focused on the dimensions of a metric that are low bandwidth because they have small value sets. It shows the current value, period over period change, and the highest ranked insight for the metric for that data. - `exploration` - Focuses on performance trends. Provides insights into the metric’s behavior over time, including summary visualizations of highs, lows, and trends, plus follow-up insights based on top-ranked data. - `breakdown` - Focuses on attribution. Provides detailed breakdowns of the top contributors for each filterable dimension of the metric. #### Legacy bundle type - `detail` - Shows insights on performance over time of the metric, a summary visualization of metric highs and lows and trends, breakdowns of top contributors for each filterable dimension of the metric, and followup insights based on the top ranked insights not already presented. While the `detail` type remains supported, we recommend using a combination of `exploration` and `breakdown` bundles instead. > **Process suggestion:** Bundles are rich and complex objects that can be challenging to build manually. One approach to efficiently create the JSON for a bundle is to use the Tableau user interface to create the form of metric definition and metrics you want to produce programmatically. Then you can navigate to a metric and use your browsers' inspector to view and copy the JSON response for the insight bundle. You can use the JSON directly or as a template in your code. ### Insight types Depending on the type of insight bundle you request and the shape of your data source, some or all of the following types of insights will be returned. | Name | Description | | --- | --- | | Period over Period Change | Shows how a metric has changed between two periods. Highlights the change between a metric value for a recent time range compared to an equivalent time range in a prior period or the past. | | Forecast (Tableau+ license edition required) | `INSIGHT_TYPE_METRIC_FORECAST` Shows the expected values for a metric for the remainder of the period, along with a forecast confidence range. Forecasts are calculated based on historical metric data and appear on the overview chart for a metric only if Tableau Pulse is confident in the forecast. Forecast confidence is affected by data quality, variance, and recency and the number of date periods to be forecast. You can see a low-confidence forecast by using the Ask button on a metric's insights exploration page. | | Concentrated Contribution Alert (Risky Monopoly) | `INSIGHT_TYPE_RISKY_MONOPOLY` Shows when a small number of dimension members make up a majority (50% or more) of the contribution to a metric. Shows dimensions with a concentration of very high values. A risky monopoly is a situation when a small number of dimension members make up a majority (50% or more) of the contribution to a metric. | | Correlated Metrics | `INSIGHT_TYPE_CORRELATED_METRIC` Shows a relationship between two metrics based on candidates that are considered for correlation. | | Top Contributors | `INSIGHT_TYPE_TOP_DIMENSION_MEMBER_MOVERS` Shows the highest values in a dimension for a metric within a given time range. A top contributor is a dimension member that ranks in the top N in contribution to the scoped metric’s value, aggregated on a specified time range. | | Bottom Contributors | `INSIGHT_TYPE_BOTTOM_CONTRIBUTORS` Shows the lowest values in a dimension for a metric within a given time range. A bottom contributor is a dimension member that ranks in the bottom N in contribution to the scoped metric’s value, aggregated on a specified time range. | | Top Drivers | `INSIGHT_TYPE_TOP_DRIVERS` Shows values for dimension members that changed the most in the same direction as the observed change in the metric. Shows the values for a metric that increased the most across a specified time offset. A top driver is a dimension member that ranks in the top N in driving a change in a metric value between two separate but equivalent time ranges. Top drivers are analyzed using metric values from two separate but equivalent time ranges (such as Sales for day of October 2 versus Sales for day of October 3) to look for changes to the contributions in the same direction of the change made by dimension members. | | Top Detractors | `INSIGHT_TYPE_TOP_DETRACTORS` Shows values for dimension members that changed the most in the opposite direction to the observed change in the metric. Shows values for a metric that are most opposed to top drivers decreased the most across a specified time offset. A top detractor is a dimension member that ranks in the bottom N in driving a change in a metric value between two separate but equivalent time ranges. This insight's values oppose the observed change the most. Top detractors are analyzed using metric values from two separate but equivalent time ranges (such as Sales for day of October 2 versus Sales for day of October 3) to look for changes to the contributions in the same direction of the change made by dimension members. | | Unusually High/Low Metric value | `INSIGHT_TYPE_UNUSUAL_CHANGE` Shows unexpected changes in a metric value. Shows when the value of a metric for a given time range is higher or lower than the expected range based on historic observations of the metric. This insight highlights when the value of a metric for a given time range is higher or lower than the expected range based on historic observations of the metric. | | New Trend Detected | `INSIGHT_TYPE_NEW_TREND` Shows new trends that vary significantly from the current trend. This insight communicates the rate of change, direction, and fluctuations for the metric value. | | Outliers | `INSIGHT_TYPE_RECORD_LEVEL_OUTLIERS` Shows values that fell outside of the range of most of the rest of the values for a metric. | | Goal and Threshold Breakdown | `INSIGHT_TYPE_BREAKDOWN_BENCHMARK` Shows the progress to goal or threshold on the breakdown chart for a metric. | | Pace to Goal (Tableau+ license edition required) | `INSIGHT_TYPE_PACE_TO_GOAL` Shows whether a metric with a sum or count aggregation is on track to reach its goal by the end of the period. Requires Forecast insight to be on. Can be turned on or off in the Insights tab in metric definition settings. If you turn off the Forecast insight, the Pace to Goal insight is also turned off. | For more detailed information on the types of insights, see [The Insights Platform and Insight Types in Tableau Pulse](https://help.tableau.com/current/online/en-us/pulse_insights_platform_insight_types.htm). ### What do Pulse REST API methods enable? > Metric definitions > > - Create, update, and delete metric definitions > - Get a list of metric definitions for a site > - Get a list of metrics for a metric definition > - Get a specified batch of metric definitions > > Metrics > > - Get the details of a metric > - Get a metric if it exists or create it if it doesn't > - Create, update, and delete a metric > - Get a specified batch of metrics > > Metric Insights > > - Generate a basic insight bundle for a metric > - Generate a springboard insight bundle for a metric > - Generate a detail insight bundle for a metric > > Metric Subscriptions > > - Get the details of a subscription to a metric > - Get a list of subscriptions to a metric for a user > - Create or delete a subscription to a metric > - Update the followers of a metric > - Get a specified batch of subscriptions to a metric > - Create subscriptions for a batch of users or groups to a metric > - Get a count of followers for a specified batch of subscriptions to a metric ## Use Postman Our Postman collection of requests enables you to construct, send, and examine HTTP requests to the Tableau Server or Tableau Cloud API without writing initial code. Postman is a free online app used by many developers for prototyping API calls, investigating issues, and generating request code in a variety of languages. Postman: [Pulse Methods](https://www.postman.com/salesforce-developers/workspace/salesforce-developers/folder/12721794-055c50d6-043e-46e4-96ea-ad3351f70778) ## List site alerts List the alerts for the authorized user user on a specified site. **Version:** Available in API 3.25 (Tableau Cloud March 2025 / Server 2025.1) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any users can list the alerts for sites that they administer. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights\_alerts:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/alerts [view details](#) ## Generate insight brief Generates an insight brief based on a user utterance by gathering insights for the specified metrics. For supplemental information, see **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_brief:create\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/brief [view details](#) ## Generate metric card image Generates a PNG image of a Pulse metric card with full visual parity to the web UI homepage. **Version:** Available in API 3.29 (Tableau Cloud June 2026) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/images/metricCard [view details](#) ## Batch list metric definitions (few) Gets the details of a batch of metric definitions and metrics on a site, specified in a brief comma delimited list of LUIDs. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions:batchGet [view details](#) ## Batch list metric definitions (many) Gets the details of a batch of definitions specified in a comma delimited list of LUIDs. This method is optimized for batches with large numbers of definitions. **Version:** Available in API 3.24 (Tableau Cloud December 2024) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can make this request but users will see results only for metrics they have permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/definitions:batchGet [view details](#) ## Batch list metrics (few) Gets a batch of metrics from a definition, specified in a comma delimited list. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can get a batch of metrics as long as the user has read or connect access to the data source used in the definition that contains them. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/metrics:batchGet [view details](#) ## Batch list metrics (many) Gets batches of metrics available on a server. Only metrics a user has privileges to view will be visible. This endpoint uses POST as an alternative to GET, where long lists of URL parameters could be problematic. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can get a batch of metrics as long as the user has read or connect access to the data source used in the definition that contains them. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics:batchGet [view details](#) ## Create metric definition Creates a metric definition. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions:create\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/definitions [view details](#) ## Create metric Creates a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:create\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics [view details](#) ## Create metric tag for user Creates a tag for the specified metric, for the signed in user. **Version:** Available in API 3.25 (Tableau Cloud March 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Anyone can make this request but users will see results only for metrics they have permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics/{metric\_id}/tag [view details](#) ## Delete metric definition Deletes a metric definition. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can delete a metric definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions:delete\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/definitions/{definition\_id} [view details](#) ## Delete metric Deletes a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can delete a metric from a definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:delete\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/metrics/{metric\_id} [view details](#) ## Delete metric tag Deletes the specified metric tag. **Version:** Available in API 3.25 (Tableau Cloud March 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Anyone can make this request but users will see results only for metrics they have permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/metrics/{metric\_id}/tag/{tag\_id} [view details](#) ## Get metric definition Gets a metric definition and optionally metrics it contains. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions/{definition\_id} [view details](#) ## Get site entitlements Returns entitlements available for a site. If entitlements are True, then Pulse premium features are enabled for the site. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only details about sited the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:entitlements:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/entitlements [view details](#) ## Get metric Gets the details of the specified metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can update a metric if they have both write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/metrics/{metric\_id} [view details](#) ## Get or create metric Returns the details of a metric in a definition if it exists, or creates a new metric if it does not. Also returns 'true' if a new metric was created, or 'false' if it already existed. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:create\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics:getOrCreate [view details](#) ## List metric definitions Lists the metric definitions configured for a site or, optionally, the details and definition for a specific metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:insight\_definitions\_metrics:read Access [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions [view details](#) ## Lists all definition tags for the site. Lists all definition tags for the site. Results can be filtered by tag value, definition name, or datasource ID. Each result includes the tag value and a count of how many definitions use it. **Version:** Available in API 3.29 (Tableau Cloud August 2026) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions/tags [view details](#) ## List metrics in definition Lists the metrics contained in a metric definition. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions/{definition\_id}/metrics [view details](#) ## Update metric definition Updates a metric definition. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can update a metric definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions:update\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PATCH {server}/api/-/pulse/definitions/{definition\_id} [view details](#) ## Update metric Updates the specification of a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:update\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PATCH {server}/api/-/pulse/metrics/{metric\_id} [view details](#) ## Generate basic insight bundle Generates a basic insight bundle. **Version:** Available in API 3.24 (Tableau Cloud December 2024) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/basic [view details](#) ## Generate breakdown insight bundle Generates a breakdown insight bundle. This provides the BAN and breakdown groups of insights. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/breakdown [view details](#) ## Generate current metric value insight bundle Generates a bundle the current aggregated value for each metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/ban [view details](#) ## Generate detail insight bundle Generates a detail insight bundle. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. For the [usage-based licensing model](https://help.tableau.com/current/online/en-us/license_product_keys.htm#usagebased-license-model), each call to this method counts as an analytical impression. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/detail [view details](#) ## Generate exploration insight bundle Generates an exploration insight bundle. This provides the BAN, anchor, and followup groups of insights. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/exploration [view details](#) ## Generate springboard insight bundle Generates a springboard insight bundle. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/springboard [view details](#) ## List metric definition measurement periods Gets the measurement periods for the specified metric definition. **Version:** Available in API 3.25 (Tableau Cloud March 2025 / Server 2025.1) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions.[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:content:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/measurementPeriods [view details](#) ## Batch create Pulse subscriptions Creates multiple subscriptions to a metric for specified users and/or groups. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can create subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:create\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/subscriptions:batchCreate [view details](#) ## Batch get Pulse subscriber counts Gets the number of unique users subscribed to a set of metrics specified in a comma separated list of metric LUIDs. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can create subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:read\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions:batchGetMetricFollowerCounts [view details](#) ## Batch get Pulse subscriptions Gets a batch of subscriptions, specified in a comma delimited list of subscriptions LUIDs. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can get the details of subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:read\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions:batchGet [view details](#) ## Create subscription Creates a subscription to a specified metric for a specified user or group. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can create subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:create\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/subscriptions [view details](#) ## Delete Pulse subscription Deletes a specified subscription to a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can delete subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:delete\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/subscriptions/{id} [view details](#) ## Gets recommended metrics Gets personalized groups of metrics to recommend to a user. Only metric that the user has privileges to view will be returned. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can get a batch of metrics as long as the user has read or connect access to the data source used in the definition that contains them. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/metrics:recommended [view details](#) ## Get Pulse subscription Gets a specified subscription to a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can get the details of a subscription. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions/{id} [view details](#) ## List Pulse user preferences Gets the signed in user's preferences for notifications channels and cadence, and for grouping and sorting followed metrics in REST responses and UI. **Version:** Available in API 3.24 (Tableau Cloud December 2024) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can get the details of subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:user\_preferences:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/user/preferences [view details](#) ## List followed metrics groups Gets the user's followed metrics. Optionally metrics can be grouped by characteristics like datasource, and sorted. **Version:** Available in API 3.23 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/metrics:followedMetricsGroups [view details](#) ## List subscriptions Lists the subscriptions to a specified metric and/or for a specified user. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can list subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:metric\_subscriptions:read Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions [view details](#) ## Update Pulse user preferences Updates the signed in user's preferences for notifications channels and cadence, and for grouping and sorting followed metrics in REST responses and UI. **Version:** Available in API 3.24 (Tableau Cloud December 2024) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can get the details of subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:user\_preferences:update\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PATCH {server}/api/-/pulse/user/preferences [view details](#)