Batch list metrics (Cloud-only)
GET {{baseUrl}}/api/-/pulse/metrics:batchGet?enable_sorting=<boolean>&metric_ids=<string>
Gets a batch of metrics from a definition, specified in a comma delimited list.
Version: Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. Versioning Overview
Permissions: Any user can get a batch of metrics as long as the user has read or connect access to the data source used in the definition that contains them. Permissions Overview
License: No additional license required.
Access Scope: tableau:insight_metrics:read
Access Scopes Overview: Cloud
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
enable_sorting | string | (Required) If true, the metrics will be sorted by the metric name. If false, the metrics will be returned in the order they were requested. | |
metric_ids | string | (Required) The metrics to get, formatted as a comma separated list of LUIDs. |
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_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"}]},{"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_BY_QUARTER","range":"RANGE_CURRENT_PARTIAL"},"comparison":{"comparison":"TIME_COMPARISON_UNSPECIFIED"}},"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_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_BY_DAY","range":"RANGE_CURRENT_PARTIAL"},"comparison":{"comparison":"TIME_COMPARISON_YEAR_AGO_PERIOD"}},"definition_id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","schema_version":"\u003cstring\u003e"}],"errors":[{"id":"\u003cstring\u003e","error":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","error":"\u003cstring\u003e"}]}