Download OpenAPI specification:Download
An API to query Tableau published data sources
Requests metadata for a specific data source. The metadata provides information about the data fields, such as field names, data types, and descriptions.
required | object (Datasource) |
object (QueryOptions) Some optional metadata that can be used to adjust the behavior of an endpoint. |
{- "datasource": {
- "datasourceLuid": "string",
- "connections": [
- {
- "connectionLuid": "string",
- "connectionUsername": "string",
- "connectionPassword": "string"
}
]
}, - "options": {
- "returnFormat": "OBJECTS",
- "debug": false
}
}
{- "data": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "dataType": "INTEGER",
- "logicalTableId": "string"
}
]
}
Queries a specific data source and returns the resulting data.
required | object (Datasource) |
required | object (Query) The query is the fundamental interface to the VizQL Data Service. It holds the specific semantics to perform against the data source. A query consists of an array of fields to query against, and an optional array of filters to apply to the query. |
object (QueryDatasourceOptions) Some optional metadata that can be used to adjust the behavior of an endpoint. |
{- "datasource": {
- "datasourceLuid": "string",
- "connections": [
- {
- "connectionLuid": "string",
- "connectionUsername": "string",
- "connectionPassword": "string"
}
]
}, - "query": {
- "fields": [
- {
- "fieldCaption": "string",
- "fieldAlias": "string",
- "maxDecimalPlaces": 0,
- "sortDirection": "ASC",
- "sortPriority": 0
}
], - "filters": [
- {
- "field": {
- "fieldCaption": "string"
}, - "filterType": "QUANTITATIVE_DATE",
- "context": false
}
]
}, - "options": {
- "returnFormat": "OBJECTS",
- "debug": false,
- "disaggregate": false
}
}
{- "data": [
- null
]
}