/datasets
GET
Returns a list of all datasets provided by the ONS that can be filtered using the filter API
Parameters
| Name | Type | Description |
|---|---|---|
| is_based_on | query | A population type to search on to return datasets that are associated with that population type e.g. Usual-Residents. This is applicable to Census 2021 datasets only. |
| limit | query | Maximum number of items that will be returned. A value of zero will return zero items. The default value is 20, and the maximum limit allowed is 1000 |
| offset | query | Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning. |
Responses
200: A json list containing datasets which have been published
Example value
{
"count": 0,
"items": [
{
"canonical_topic": "string",
"collection_id": "string",
"contacts": [
{
"email": "string",
"name": "string",
"telephone": "string"
}
],
"description": "string",
"id": "string",
"is_based_on": {
"id": "Usual-Residents",
"type": "cantabular_table"
},
"keywords": [
"string"
],
"license": "string",
"links": {
"access_rights": {
"href": "string"
},
"editions": {
"href": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions"
},
"latest_version": {
"href": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/versions/2",
"id": "string"
},
"self": {
"href": "string"
},
"taxonomy": {
"href": "string"
}
},
"methodologies": [
{
"description": "string",
"href": "string",
"title": "string"
}
],
"national_statistic": true,
"next_release": "string",
"publications": [
{
"description": "string",
"href": "string",
"title": "string"
}
],
"publisher": {
"href": "string",
"name": "string",
"type": "string"
},
"qmi": {
"description": "string",
"href": "string",
"title": "string"
},
"related_content": [
{
"description": "string",
"href": "string",
"title": "string"
}
],
"related_datasets": [
{
"href": "string",
"title": "string"
}
],
"release_frequency": "string",
"state": "string",
"subtopics": [
"string"
],
"survey": "string",
"theme": "string",
"themes": [
"string"
],
"title": "CPI",
"type": "cantabular_flexible_table",
"unit_of_measure": "string",
"uri": "string"
}
],
"limit": 0,
"offset": 0,
"total_count": 0
}