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

HEADERS

Key	Datatype	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.
`Content-Type`	string
`Accept`	string

RESPONSES

status: Created

{&quot;bundle_response&quot;:{&quot;result&quot;:{&quot;insight_groups&quot;:[{&quot;type&quot;:&quot;ban&quot;,&quot;insights&quot;:[{&quot;result&quot;:{&quot;type&quot;:&quot;popc&quot;,&quot;version&quot;:1,&quot;content&quot;:&quot;&quot;,&quot;markup&quot;:&quot;There was an  increase of +2 (+33.3%) over December 28, 2023.&quot;,&quot;viz&quot;:{},&quot;facts&quot;:{&quot;target_period_value&quot;:{&quot;raw&quot;:8,&quot;formatted&quot;:&quot;8&quot;},&quot;comparison_period_value&quot;:{&quot;raw&quot;:6,&quot;formatted&quot;:&quot;6&quot;},&quot;target_time_period&quot;:{&quot;range&quot;:&quot;Dec 29, 2023&quot;,&quot;label&quot;:&quot;Dec 29&quot;,&quot;granularity&quot;:&quot;day&quot;,&quot;start_timestamp&quot;:&quot;2023-12-29T00:00:00Z&quot;,&quot;end_timestamp&quot;:&quot;2023-12-30T00:00:00Z&quot;},&quot;comparison_time_period&quot;:{&quot;end_timestamp&quot;:&quot;2023-12-29T00:00:00Z&quot;,&quot;range&quot;:&quot;Dec 28, 2023&quot;,&quot;label&quot;:&quot;Dec 28&quot;,&quot;granularity&quot;:&quot;day&quot;,&quot;start_timestamp&quot;:&quot;2023-12-28T00:00:00Z&quot;},&quot;difference&quot;:{&quot;relative&quot;:{&quot;formatted&quot;:&quot;33.3%&quot;,&quot;raw&quot;:0.3333333333333333},&quot;direction&quot;:&quot;up&quot;,&quot;absolute&quot;:{&quot;raw&quot;:2,&quot;formatted&quot;:&quot;2&quot;}},&quot;sentiment&quot;:&quot;neutral&quot;},&quot;characterization&quot;:&quot;CHARACTERIZATION_UNSPECIFIED&quot;,&quot;question&quot;:&quot;How has Maintenance Hours changed?&quot;,&quot;score&quot;:0,&quot;id&quot;:&quot;c864234a-9b21-43d0-a538-22d23c149a11&quot;,&quot;insight_feedback_metadata&quot;:{&quot;type&quot;:&quot;popc&quot;,&quot;score&quot;:0,&quot;dimension_hash&quot;:&quot;&quot;}},&quot;insight_type&quot;:&quot;popc&quot;}],&quot;summaries&quot;:[]}],&quot;has_errors&quot;:false,&quot;characterization&quot;:&quot;CHARACTERIZATION_UNSPECIFIED&quot;}}}