Batch get subscriber counts
GET {{baseUrl}}/api/-/pulse/subscriptions:batchGetMetricFollowerCounts?metric_ids=<string>
Gets the number of unique users subscribed to a set of metrics specified in a comma separated list of metric LUIDs.
For metrics with group followers, the count will be the union of all the members of the subscribed groups plus all the individual followers. Users are counted only once per metric.
Version: Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. Versioning Overview
Permissions: Any user that has read or connect permission to the data source used in the definition can create subscriptions. Permissions Overview
License: No additional license required.
Access Scope: tableau:metric_subscriptions:read
Access Scopes Overview: Cloud
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
metric_ids | string | (Required) The metrics to get follower counts for, formatted as a comma separated list of LUIDs. If no LUIDs are specified, the follower count for all metrics in a definition will be returned. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Tableau-Auth | string | The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. | |
| The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource. | |||
Accept | string |
RESPONSES
status: OK
{"follower_counts":[{"metric_id":"\u003cstring\u003e","follower_count":"\u003cinteger\u003e"},{"metric_id":"\u003cstring\u003e","follower_count":"\u003cinteger\u003e"}]}