get

HTTP Request

GET /api/v1/datasets/:datasetId/:versionTag

Parameters

Parameter name

Value

Description

Path parameters

:datasetId

integer

ID of the requested dataset

:versionTag

string

A version tag of the form v1.0 or one of latest or head

Optional query parameters

access_token

string

Your API access token

Data.overview — You must have overview access to the dataset.

Public — The dataset overview must be publicly visible.

Response

Returns a JSON response of the form:

{
"id": integer,
"name": string,
"url": string,
"description": 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("overview"|"metadata"|"data"),
"variableCount": integer,
"numBytes": integer,
"createdAt": string(timestamp),
"updatedAt": string(timestamp),
"temporalRange": {
"precision": string("year"|"date"|"dateTime"),
// Value will always be a dateTime regardless of precision:
// min will be the min dateTime within given precision
// max will be the max dateTime within the given precision
// For example, for precision "year", where a user has specified the range 2010-2014:
// min = "2010-01-01T00:00:00.000Z"
// max = "2014-12-31T23:59:59.999Z"
"min": string(dateTime),
"max": string(dateTime),
},
"organization": {
"id": integer,
"shortName": string,
"name": string,
"url": string
},
// If permissionGroup is null, this dataset is publicly available
"permissionGroup": {
"id": integer,
"name": string,
"url": string
},
"documentations": [
{
"accessLevel": string("overview"|"metadata"|"data"),
// text will be null if the accessLevel on the documentation is higher than the requesting user's access
"text": string // gfm markdown supported
}
],
"collections": [
{
"kind": "collection",
"id": integer,
"name": string
}
],
// Note: entity may be null
"entity": {
"kind": "entity",
"name": string
},
"tags": [
{
"kind": "tag",
"name": string
}
]
}

Examples

# List 10 collections belonging to the StanfordPHS organization
curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://redivis.com/api/datasets/116/latest"