get

Retrieve the documentation and metadata associated with a collection

HTTP Request

GET /api/v1/collections/:collectionId

Parameters

Parameter

Type

Description

Path parameters

:collectionId

integer

unique id of the collection

Data.overview — You must have overview access to at least one dataset in the collection.

Public — At least one dataset in the collection must be publicly visible.

Response

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

{
"id": integer,
"name": string,
"url": string,
"createdAt": string(timestamp),
"updatedAt": string(timestamp),
"datasetCount": integer,
"numRows": string(int64),
"numBytes": string(int64),
"variableCount": integer,
"minTimepoint": string(dateTime),
"maxTimepoint": string(dateTime),
"entities": [
{
"name": string
"countInCollection": integer
}
]
"tags": [
{
"kind": "tag",
"name": string,
"countInCollection": integer
}
],
"documentation": string // gfm markdown supported
}

Examples

# Retrieve the "Health Inequality Project" collection at https://redivis.com/StanfordPHS?collection=16
curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://redivis.com/api/collections/16"