Delete metric (Cloud-only)

DELETE {{baseUrl}}/api/-/pulse/metrics/:metric_id

Deletes a metric.

Note: When a definition is created, a default metric is created for it. A default metric can't be deleted, unless its definition is deleted, and trying will result in a 400 error.

Version: Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. Versioning Overview

Permissions: Any user can delete a metric from a definition as long as the user has write or publish access to the data source used in the definition. Permissions Overview

License: No additional license required.

Access Scope: tableau:insight_metrics:delete
Access Scopes Overview: Cloud

HEADERS

KeyDatatypeRequiredDescription
X-Tableau-AuthstringThe 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.
Acceptstring

RESPONSES

status: Created