Create subscription (Cloud-only)
POST {{baseUrl}}/api/-/pulse/subscriptions
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. 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:create
Access Scopes Overview: Cloud
Request Body
{"metric_id"=>"<string>", "follower"=>{"user_id"=>"<string>", "group_id"=>"<string>"}}
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. | |||
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"subscription":{"id":"\u003cstring\u003e","metric_id":"\u003cstring\u003e","follower":{"user_id":"\u003cstring\u003e","group_id":"\u003cstring\u003e"},"create_time":"\u003cstring\u003e","update_time":"\u003cstring\u003e"}}