list

HTTP Request

GET /api/v1/tables/:tableId/variables
GET /api/v1/datasets/:datasetId/versions/:versionTag/table/variables

Parameters

Value

Description

Path parameters

:datasetId

integer

The unique identifier for the dataset.

:tableId

integer

The unique identifier for the table.

:versionTag

string

Version tag of the form v1.0 . You can also specify latest to retrieve the latest version's data.

Query parameters

pageToken

string

Optional. Page token, returned by a previous call, to request the next page of results.

maxResults

unsigned integer

Optional. Maximum number of results to return. Defaults to 100, may not exceed 5000 (the maximum number of variables allowed on a table).

metadataFields

string

Comma-separated list of metadata fields to retrieve. Valid values are label,description,valueLabels. Defaults to null.

Please note that the label may be up to 256B, description may be up to 5KB, and valueLabels may be up to 50KB per variable.

Data.metadata — You must have "metadata" access to the dataset / table.

Public — The metadata in the dataset / table must be publicly available.

Response

If successful, this method returns a response body with the following structure:

{
"nextPageToken": string,
"variables": [
{
"id": integer,
"name": string, // up to 60 characters
"index": integer,
"type": string('float'|'integer'|'string'|'boolean'|'date'|'dateTime'|'time'),
// label, description, and valueLabels are only visible if specified
// in the metadataFields query parameter
"label": string, // up to 256 characters
"description": string, // up to 5,000 characters
"valueLabels": [ // up to 50KB
{
"value": string|number,
"label": string|number
}
]
}
]
}