VizQL Data Service (1.0)

Download OpenAPI specification:Download

An API to query Tableau published data sources

HeadlessBI

Request data source metadata

Requests metadata for a specific data source. The metadata provides information about the data fields, such as field names, data types, and descriptions.

Authorizations:

XTableauAuth

Request Body schema: application/json

required	object (Datasource)
	object (QueryOptions) Some optional metadata that can be used to adjust the behavior of an endpoint.

Responses

Request samples

Payload

Content type

application/json

{"datasource": {"datasourceLuid": "string",
"connections": [{"connectionLuid": "string",
"connectionUsername": "string",
"connectionPassword": "string"
}
]
},
"options": {"debug": false,
"bypassMetadataCache": false,
"interpretFieldCaptionsAsFieldNames": false
}
}

Response samples

200
default

Content type

application/json

{"data": [{"fieldName": "string",
"fieldCaption": "string",
"dataType": "INTEGER",
"defaultAggregation": "SUM",
"columnClass": "COLUMN",
"formula": "string",
"logicalTableId": "string"
}
],
"extraData": {"parameters": [{"parameterType": "ANY_VALUE",
"parameterName": "string",
"parameterCaption": "string",
"dataType": "INTEGER",
"value": null
}
]
}
}

Query data source

Queries a specific data source and returns the resulting data.

Authorizations:

XTableauAuth

Request Body schema: application/json

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.

Responses

Request samples

Payload

Content type

application/json

{"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
}
],
"parameters": [{"parameterCaption": "string",
"value": null
}
]
},
"options": {"debug": false,
"bypassMetadataCache": false,
"interpretFieldCaptionsAsFieldNames": false,
"disaggregate": false,
"returnFormat": "OBJECTS"
}
}

Response samples

200
default

Content type

application/json

{"data": [null
]
}

Send a simple request

Sends a request that can be used for testing or doing a health check.

Responses

Response samples

200

Content type

application/json

"string"

Request data source model

Requests the data model for a specific data source. The data model provides information about the structure and relationships in the data source.

Authorizations:

XTableauAuth

Request Body schema: application/json

required	object (Datasource)
	object (QueryOptions) Some optional metadata that can be used to adjust the behavior of an endpoint.

Responses

Request samples

Payload

Content type

application/json

{"datasource": {"datasourceLuid": "string",
"connections": [{"connectionLuid": "string",
"connectionUsername": "string",
"connectionPassword": "string"
}
]
},
"options": {"debug": false,
"bypassMetadataCache": false,
"interpretFieldCaptionsAsFieldNames": false
}
}

Response samples

200
default

Content type

application/json

{"logicalTables": [{"logicalTableId": "string",
"caption": "string"
}
],
"logicalTableRelationships": [{"fromLogicalTable": {"logicalTableId": "string"
},
"toLogicalTable": {"logicalTableId": "string"
}
}
]
}