Create metric definition (Cloud-only)

POST {{baseUrl}}/api/-/pulse/definitions

Creates a metric definition.

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

Permissions: Any user can create a metric 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_definitions:create
Access Scopes Overview: Cloud

Request Body

{"name"=>"<string>", "description"=>"<string>", "specification"=>{"datasource"=>{"id"=>"<string>"}, "basic_specification"=>{"measure"=>{"field"=>"<string>", "aggregation"=>"AGGREGATION_UNSPECIFIED"}, "time_dimension"=>{"field"=>"<string>"}, "filters"=>[{"field"=>"<string>", "operator"=>"OPERATOR_EQUAL", "categorical_values"=>[{"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}, {"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}]}, {"field"=>"<string>", "operator"=>"OPERATOR_NOT_EQUAL", "categorical_values"=>[{"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}, {"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}]}]}, "viz_state_specification"=>{"viz_state_string"=>"<string>"}, "is_running_total"=>"<boolean>"}, "extension_options"=>{"allowed_dimensions"=>["<string>", "<string>"], "allowed_granularities"=>["GRANULARITY_BY_YEAR", "GRANULARITY_BY_WEEK"]}, "representation_options"=>{"type"=>"NUMBER_FORMAT_TYPE_NUMBER", "number_units"=>{"singular_noun"=>"<string>", "plural_noun"=>"<string>"}, "sentiment_type"=>"SENTIMENT_TYPE_DOWN_IS_GOOD", "row_level_id_field"=>{"identifier_col"=>"<string>", "identifier_label"=>"<string>"}, "row_level_entity_names"=>{"entity_name_singular"=>"<string>", "entity_name_plural"=>"<string>"}}, "insights_options"=>{"settings"=>[{"type"=>"INSIGHT_TYPE_TOP_DETRACTORS", "disabled"=>"<boolean>"}, {"type"=>"INSIGHT_TYPE_RECORD_LEVEL_OUTLIERS", "disabled"=>"<boolean>"}]}}

HEADERS

RESPONSES

status: Created

{"definition":{"metadata":{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","schema_version":"\u003cstring\u003e","definition_version":"\u003clong\u003e"},"specification":{"datasource":{"id":"\u003cstring\u003e"},"basic_specification":{"measure":{"field":"\u003cstring\u003e","aggregation":"AGGREGATION_UNSPECIFIED"},"time_dimension":{"field":"\u003cstring\u003e"},"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_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"}]}]},"viz_state_specification":{"viz_state_string":"\u003cstring\u003e"},"is_running_total":"\u003cboolean\u003e"},"extension_options":{"allowed_dimensions":["\u003cstring\u003e","\u003cstring\u003e"],"allowed_granularities":["GRANULARITY_BY_DAY","GRANULARITY_BY_QUARTER"]},"metrics":[{"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_YEAR","range":"RANGE_LAST_COMPLETE"},"comparison":{"comparison":"TIME_COMPARISON_YEAR_AGO_PERIOD"}},"definition_id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","schema_version":"\u003cstring\u003e"},{"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_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_MONTH","range":"RANGE_LAST_COMPLETE"},"comparison":{"comparison":"TIME_COMPARISON_NONE"}},"definition_id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","schema_version":"\u003cstring\u003e"}],"total_metrics":"\u003clong\u003e","representation_options":{"type":"NUMBER_FORMAT_TYPE_PERCENT","number_units":{"singular_noun":"\u003cstring\u003e","plural_noun":"\u003cstring\u003e"},"sentiment_type":"SENTIMENT_TYPE_DOWN_IS_GOOD","row_level_id_field":{"identifier_col":"\u003cstring\u003e","identifier_label":"\u003cstring\u003e"},"row_level_entity_names":{"entity_name_singular":"\u003cstring\u003e","entity_name_plural":"\u003cstring\u003e"}},"insights_options":{"settings":[{"type":"INSIGHT_TYPE_UNSPECIFIED","disabled":"\u003cboolean\u003e"},{"type":"INSIGHT_TYPE_RISKY_MONOPOLY","disabled":"\u003cboolean\u003e"}]}}}