get

Retrieve detailed information about a table and its export restrictions

HTTP Request

GET /api/v1/tables/:tableId
GET /api/v1/datasets/:datasetId/:versionTag/table
GET /api/v1/datasets/:datasetId/:versionTag/sample

Parameters

Parameter name

Value

Description

Path parameters

:datasetId

integer

The unique identifier for the dataset.

:versionTag

string

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

:tableId

integer

The unique identifier for the table.

Query parameters

access_token

string

Your API access token

Request body

Do not supply a request body with this method.

User.read — You must have read access to the project.

Public — The project must be publicly visible.

Data.overview — You must have overview access to all source datasets of the table.

Public —  All source datasets must be publicly visible.

Response

Returns a JSON representation of the table resource

{
"id": integer,
"description": string,
"url": string,
"createdAt": string(timestamp),
"updatedAt": string(timestamp),
"hash": string,
"numRows": integer,
"numBytes": integer,
"variableCount": integer,
"canExport": boolean,
// The accessLevel of the table to unauthenticated users. This property
// ignores whether they have access to the underlying project,
// and is solely based on the table's datasets' access restrions
"publicAccessLevel": string("none"|"overview"|"metadata"|"data"),
// The accessLevel of the current token being used
// (this will never be higher than your access level)
"scopedAccessLevel": string("none"|"overview"|"metadata"|"data"),
// Your accessLevel
"accessLevel": string("none"|"overview"|"metadata"|"data")
"exportRestrictions": [
{
"message": string // a human-readable string regarding the error message
}
],
"sourceDatasets": [
{
// id and name will be null if the dataset's accessLevel
// is 'none'. However, organization or user will still be
// present.
"id": integer,
"name": string,
"url": string,
// The accessLevel of the dataset to unauthenticated users.
"publicAccessLevel": string("none"|"overview"|"metadata"|"data"),
// The accessLevel of the current token being used
// (this will never be higher than your access level)
"scopedAccessLevel": string("none"|"overview"|"metadata"|"data"),
// Your accessLevel
"accessLevel": string("none"|"overview"|"metadata"|"data")
// all datasets are associate with an organization OR a user,
// never both
"organization": {
"id": integer,
"shortName": string
},
"user": {
"id": integer,
"userName": string
},
}
]
}