List metrics in definition
GET {{baseUrl}}/api/-/pulse/definitions/:definition_id/metrics?page_size=<integer>&page_token=<string>&enable_sorting=<boolean>&order_by=<string>&filter=<string>
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. Versioning Overview
Permissions: Can be called by any user, but only returns definitions and metrics that the user has permissions to view. Permissions Overview
License: No additional license required.
Access Scope: tableau:insightdefinitionsmetrics: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>. |
| enable_sorting | string | | |
| order_by | string | | |
| filter | 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. | |||
Accept | string |
RESPONSES
status: OK
{"metrics":[{"id":"\u003cstring\u003e","specification":{"filters":[{"field":"\u003cstring\u003e","operator":"OPERATOR_EQUAL","categorical_values":[{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"},{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"}]},{"field":"\u003cstring\u003e","operator":"OPERATOR_UNSPECIFIED","categorical_values":[{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"},{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"}]}],"measurement_period":{"granularity":"GRANULARITY_UNSPECIFIED","range":"RANGE_UNSPECIFIED"},"comparison":{"comparison":"TIME_COMPARISON_PREVIOUS_PERIOD"}},"definition_id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","schema_version":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","specification":{"filters":[{"field":"\u003cstring\u003e","operator":"OPERATOR_NOT_EQUAL","categorical_values":[{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"},{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"}]},{"field":"\u003cstring\u003e","operator":"OPERATOR_EQUAL","categorical_values":[{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"},{"string_value":"\u003cstring\u003e","bool_value":"\u003cboolean\u003e","null_value":"\u003cstring\u003e"}]}],"measurement_period":{"granularity":"GRANULARITY_BY_WEEK","range":"RANGE_UNSPECIFIED"},"comparison":{"comparison":"TIME_COMPARISON_YEAR_AGO_PERIOD"}},"definition_id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","schema_version":"\u003cstring\u003e"}],"next_page_token":"\u003cstring\u003e","total_available":"\u003cinteger\u003e","offset":"\u003cinteger\u003e"}