Get a data set version
Get a data set version’s summary details.
The URL for this endpoint is:
GET https://dev.statistics.api.education.gov.uk/api/v{version}/data-sets/{dataSetId}/versions/{dataSetVersion}
Parameters
Path parameters
The following parameters will need to be substituted into the URL path.
Parameter | Type | Required | Description |
---|---|---|---|
dataSetId |
string | true |
The ID of the data set. |
dataSetVersion |
string | true |
The data set version e.g. 1.0, 1.1, 2.0, etc. |
version |
string | true |
The requested API version Defaults to: |
Example request
To illustrate how to use this API endpoint, we have provided some samples below in various languages.
cURL
curl -X GET https://dev.statistics.api.education.gov.uk/api/v{version}/data-sets/{dataSetId}/versions/{dataSetVersion}
JavaScript
const url = 'https://dev.statistics.api.education.gov.uk/api/v{version}/data-sets/{dataSetId}/versions/{dataSetVersion}';
const response = await fetch(url, {
method: 'GET',
});
console.log(response.json());
Python
import requests
url = 'https://dev.statistics.api.education.gov.uk/api/v{version}/data-sets/{dataSetId}/versions/{dataSetVersion}'
response = requests.get(url)
print(response.text)
R
library(httr)
url <- "https://dev.statistics.api.education.gov.uk/api/v{version}/data-sets/{dataSetId}/versions/{dataSetVersion}"
response <- GET(url)
output <- content(response)
Responses
Status | Description | Media Type | Schema |
---|---|---|---|
200 | The requested data set version. |
application/json | DataSetVersionViewModel |
403 | Forbidden |
application/json | ProblemDetailsViewModel |
404 | Not Found |
application/json | ProblemDetailsViewModel |
Example successful response
{
"version": "1.0",
"type": "Major",
"status": "Published",
"published": "2024-03-01T09:30:00+00:00",
"withdrawn": "2024-06-01T12:00:00+00:00",
"notes": "Some notes about the version.",
"totalResults": 1000000,
"file": {
"id": "e0754872-3206-4918-aad4-029eaaae191f"
},
"release": {
"title": "Spring term 2023/24",
"slug": "2023-24-spring-term"
},
"timePeriods": {
"start": "2024 January",
"end": "2024 December"
},
"geographicLevels": [
"National",
"Regional",
"Local authority"
],
"filters": [
"Characteristic",
"School type"
],
"indicators": [
"Authorised absence rate",
"Overall absence rate"
]
}