get

HTTP Request

GET /api/v1/tables/:tableReference/variables/:variableName
GET /api/v1/queries/:queryId/variables/:variableName

Path parameters

Parameter

tableReference

A qualified reference to the table. See referencing resources for more information.

queryId

The id of the query, used when listing the variables in a query's output.

variableName

The variable's name (case insensitive)

Query parameters

Parameter

maxResults

Default 100. Must be less than 1000.

nextPageToken

For paginating through results, provide the value returned from the previous table.listVariables call

This endpoint extends the general API structure.

Authorization

Metadata access to the table is required. If a table's data is not public, your access token must have one of the following scopes:

  • data.metadata

  • data.data

  • data.edit

Learn more about authorization.

Request body

The request body must be empty.

Response body

Returns a JSON representation of a variable resource.

Examples