Generate current metric value insight bundle

POST {{baseUrl}}/api/-/pulse/insights/ban

Generates a bundle the current aggregated value for each metric.

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 in a definition as long as the user has read or connect access to the data source used in the definition. Permissions Overview

License: No additional license required.

Access Scope: tableau:insights:read
Access Scopes Overview: Cloud

Request Body

{"bundle_request"=>{"version"=>"<integer>", "options"=>{"output_format"=>"OUTPUT_FORMAT_HTML", "now"=>"<string>", "time_zone"=>"<string>"}, "input"=>{"metadata"=>{"name"=>"<string>", "metric_id"=>"<string>", "definition_id"=>"<string>"}, "metric"=>{"definition"=>{"datasource"=>{"id"=>"<string>"}, "basic_specification"=>{"measure"=>{"field"=>"<string>", "aggregation"=>"AGGREGATION_MIN"}, "time_dimension"=>{"field"=>"<string>"}, "filters"=>[{"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>"}]}, {"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>"}]}]}, "viz_state_specification"=>{"viz_state_string"=>"<string>"}, "is_running_total"=>"<boolean>"}, "metric_specification"=>{"filters"=>[{"field"=>"<string>", "operator"=>"OPERATOR_UNSPECIFIED", "categorical_values"=>[{"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}, {"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}]}, {"field"=>"<string>", "operator"=>"OPERATOR_UNSPECIFIED", "categorical_values"=>[{"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}, {"string_value"=>"<string>", "bool_value"=>"<boolean>", "null_value"=>"<string>"}]}], "measurement_period"=>{"granularity"=>"GRANULARITY_BY_WEEK", "range"=>"RANGE_LAST_COMPLETE"}, "comparison"=>{"comparison"=>"TIME_COMPARISON_PREVIOUS_PERIOD"}}, "extension_options"=>{"allowed_dimensions"=>["<string>", "<string>"], "allowed_granularities"=>["GRANULARITY_BY_YEAR", "GRANULARITY_BY_DAY"]}, "representation_options"=>{"type"=>"NUMBER_FORMAT_TYPE_CURRENCY", "number_units"=>{"singular_noun"=>"<string>", "plural_noun"=>"<string>"}, "sentiment_type"=>"SENTIMENT_TYPE_UP_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_BOTTOM_CONTRIBUTORS", "disabled"=>"<boolean>"}]}}}}}

HEADERS

RESPONSES

status: Created

{"bundle_response":{"result":{"insight_groups":[{"type":"\u003cstring\u003e","insights":[{"result":{"type":"\u003cstring\u003e","version":"\u003cinteger\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"aliquip_d_":{}}},"facts":{"fields":{"laborum8a":{}}},"characterization":"CHARACTERIZATION_UNUSUAL","question":"\u003cstring\u003e","score":"\u003cnumber\u003e","id":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}},{"result":{"type":"\u003cstring\u003e","version":"\u003cinteger\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"laborisd3":{},"officiaa3":{},"mollit2b":{}}},"facts":{"fields":{"culpaeb":{},"ut5_":{},"commodo_2":{},"sint1":{}}},"characterization":"CHARACTERIZATION_NORMAL","question":"\u003cstring\u003e","score":"\u003cnumber\u003e","id":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}}],"summaries":[{"result":{"id":"\u003cstring\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"Ut64":{}}},"generation_id":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","last_attempted_timestamp":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}},{"result":{"id":"\u003cstring\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"enim14":{}}},"generation_id":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","last_attempted_timestamp":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}}]},{"type":"\u003cstring\u003e","insights":[{"result":{"type":"\u003cstring\u003e","version":"\u003cinteger\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"consectetur3_":{},"fugiat6ea":{}}},"facts":{"fields":{"aute_26f":{}}},"characterization":"CHARACTERIZATION_NORMAL","question":"\u003cstring\u003e","score":"\u003cnumber\u003e","id":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}},{"result":{"type":"\u003cstring\u003e","version":"\u003cinteger\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"adipisicing3":{},"fugiat_f":{}}},"facts":{"fields":{"aliqua_39":{}}},"characterization":"CHARACTERIZATION_UNSPECIFIED","question":"\u003cstring\u003e","score":"\u003cnumber\u003e","id":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}}],"summaries":[{"result":{"id":"\u003cstring\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"laborum_d7d":{},"irured":{}}},"generation_id":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","last_attempted_timestamp":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}},{"result":{"id":"\u003cstring\u003e","markup":"\u003cstring\u003e","viz":{"fields":{"voluptate066":{},"in28":{}}},"generation_id":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","last_attempted_timestamp":"\u003cstring\u003e"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}}]}],"has_errors":"\u003cboolean\u003e","characterization":"CHARACTERIZATION_UNUSUAL"},"error":{"code":"\u003cstring\u003e","message":"\u003cstring\u003e"}}}