API docs by Redocly

VizQL Data Service (1.0)

Download OpenAPI specification:Download

An API to access Tableau published data sources

ReadMetadata

Requests metadata about a published datasource

Authorizations:
(CredentialKeyCredentialValue) CredentialJWT
Request Body schema: application/json
required
object (Connection)
object (QueryOptions)

Some optional metadata that can be used to adjust the behavior of an endpoint

Responses

Request samples

Content type
application/json
{
  • "connection": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

QueryDatasource

Executes a single query against a published datasource

Authorizations:
(CredentialKeyCredentialValue) CredentialJWT
Request Body schema: application/json
required
object (Connection)
required
object (Query)

The Query is the fundamental interface to Headless BI. It holds the specific semantics to perform against the Data Source. A Query consists of an array of Columns to query against, an optional array of filters to apply to the query, and an optional Metadata field to modify the query behavior.

object (QueryDatasourceOptions)

Some optional metadata that can be used to adjust the behavior of a datasource query.

Responses

Request samples

Content type
application/json
{
  • "connection": {
    },
  • "query": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

SimpleRequest

A simple request that can be used for testing or healthcheck

Responses

Response samples

Content type
application/json
"string"