Qodex.ai

Get ask data lens - Retired in API 3.22

GET {{baseUrl}}/api/-/askdata/lenses/:lens_id

Retired in API 3.22 (Cloud February 2024 / Server 2024.2)

In February 2024, Tableau's Ask Data and Metrics features and their REST API methods will be retired in Tableau Cloud and Tableau Server version 2024.1. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see How Tableau GPT and Tableau Pulse are reimagining the data experience.

Get the details of the specified ask data lens.

Version: Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. Versioning Overview

Permissions: This method can be called by users who have Read access to the lens. Permissions Overview

License: No additional license required.

Access Scope: tableau:lenses:read
Access Scopes Overview: Cloud | Server-Windows | Server-Linux

HEADERS

KeyDatatypeRequiredDescription
X-Tableau-AuthstringThe 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.
Acceptstring

RESPONSES

status: OK

{"lens":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","site_id":"\u003cstring\u003e","datasource_id":"\u003cstring\u003e","project_id":"\u003cstring\u003e","owner_id":"\u003cstring\u003e","description":"\u003cstring\u003e","repository_url":"\u003cstring\u003e","is_feedback_enabled":"\u003cboolean\u003e","fields":[{"graph_id":"\u003cstring\u003e","custom_label":"\u003cstring\u003e","custom_description":"\u003cstring\u003e","field_synonyms":["\u003cstring\u003e","\u003cstring\u003e"],"inherited_field_synonyms":["\u003cstring\u003e","\u003cstring\u003e"],"value_synonyms":[{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]},{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]}],"inherited_value_synonyms":[{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]},{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]}]},{"graph_id":"\u003cstring\u003e","custom_label":"\u003cstring\u003e","custom_description":"\u003cstring\u003e","field_synonyms":["\u003cstring\u003e","\u003cstring\u003e"],"inherited_field_synonyms":["\u003cstring\u003e","\u003cstring\u003e"],"value_synonyms":[{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]},{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]}],"inherited_value_synonyms":[{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]},{"value":"\u003cstring\u003e","synonyms":["\u003cstring\u003e","\u003cstring\u003e"]}]}],"recommended_visualization_groups":[{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","recommended_visualizations":[{"expression":"\u003cstring\u003e","interpretation":"\u003cstring\u003e","colloquial_alias":"\u003cstring\u003e"},{"expression":"\u003cstring\u003e","interpretation":"\u003cstring\u003e","colloquial_alias":"\u003cstring\u003e"}]},{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","recommended_visualizations":[{"expression":"\u003cstring\u003e","interpretation":"\u003cstring\u003e","colloquial_alias":"\u003cstring\u003e"},{"expression":"\u003cstring\u003e","interpretation":"\u003cstring\u003e","colloquial_alias":"\u003cstring\u003e"}]}]}}