Query Datasource

Executes VizQL queries against Tableau data sources to answer business questions from published data.

APIs called

• Query Data Source from VizQL Data Service
• Query Data Source from REST API (if applicable tool scoping is enabled)

Environment variables

• DISABLE_QUERY_DATASOURCE_VALIDATION_REQUESTS

Required arguments

datasourceLuid

The LUID of the data source, potentially retrieved by the List Data Sources tool.

Example: 2d935df8-fe7e-4fd8-bb14-35eb4ba31d45

---

query

The VizQL query to execute against the data source. See Create a Query for more information.

Example:

{
  "fields": [
    {
      "fieldCaption": "Customer Name"
    },
    {
      "fieldCaption": "Sales",
      "function": "SUM",
      "fieldAlias": "Total Revenue",
      "sortDirection": "DESC",
      "sortPriority": 1
    }
  ],
  "filters": [
    {
      "field": {
        "fieldCaption": "Customer Name"
      },
      "filterType": "TOP",
      "howMany": 5,
      "direction": "TOP",
      "fieldToMeasure": {
        "fieldCaption": "Sales",
        "function": "SUM"
      }
    }
  ]
}

---

Optional arguments

limit

The maximum number of rows to return. The tool will return at most this many rows.

Example: 2000

See also: MAX_RESULT_LIMIT

Example result

{
  "data": [
    {
      "Customer Name": "Sean Miller",
      "Total Revenue": 25043.05
    },
    {
      "Customer Name": "Tamara Chand",
      "Total Revenue": 19052.217999999997
    },
    {
      "Customer Name": "Raymond Buch",
      "Total Revenue": 15117.338999999998
    },
    {
      "Customer Name": "Tom Ashbrook",
      "Total Revenue": 14595.62
    },
    {
      "Customer Name": "Adrian Barton",
      "Total Revenue": 14473.571
    }
  ]
}