List subscriptions
GET {{baseUrl}}/api/-/pulse/subscriptions?user_id={{user-id}}
Lists the subscriptions to a specified metric and/or for a specified user.
If only metric-id is specified, all subscriptions for that metric are returned.
If only user-id is specified, al subscriptions for that user are returned.
If both metric_id or user_id and specified, then the user's subscription for the specified metric is returned.
If no metric_id or user_id is specified, all subscriptions on the site will be returned.
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 list subscriptions. Permissions Overview
License: No additional license required.
Access Scope: tableau:metric_subscriptions:read
Access Scopes Overview: Cloud
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_size | string | Specifies the number of results in a paged response. |
Example:
> GET .../subscriptions?pageSize=50
Combining Path Parameters: A page_size expression can be combined with other path parameters using an ampersand (&) as a separator, and is typically used along with a page number expression.
<a href='https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_paging.htm' target='_blank'>Learn more about paginating the response</a>. |
| page_token | string | | Specifies the page of items to be returned from a requested list.
The value of page_token for the next page of returns is found in
the next_page_token of the current response. If there are no
further items to return, the value of next_page_token will be
empty.
Example:
> GET .../definitions?pageToken={next_page_value}
Combining Path Parameters: A page_token expression can be combined with other path parameters using an ampersand (&) as a separator, and is typically used along with a page number expression.
<a href='https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_paging.htm' target='_blank'>Learn more about paginating the response</a>. |
| user_id | string | | The LUID of a user whose subscriptions will be returned. |
| metric_id | string | | The LUID of a metric whose subscriptions 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
{"subscriptions":[{"id":"\u003cstring\u003e","metric_id":"\u003cstring\u003e","follower":{"user_id":"\u003cstring\u003e","group_id":"\u003cstring\u003e"},"create_time":"\u003cstring\u003e","update_time":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","metric_id":"\u003cstring\u003e","follower":{"user_id":"\u003cstring\u003e","group_id":"\u003cstring\u003e"},"create_time":"\u003cstring\u003e","update_time":"\u003cstring\u003e"}],"next_page_token":"\u003cstring\u003e"}