Get a data set version’s changes

Lists the changes made by a data set version relative to the version prior to it.

The URL for this endpoint is:

GET https://dev.statistics.api.education.gov.uk/api/v{version}/data-sets/{dataSetId}/versions/{dataSetVersion}/changes

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: 1.0

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}/changes

JavaScript

const url = 'https://dev.statistics.api.education.gov.uk/api/v{version}/data-sets/{dataSetId}/versions/{dataSetVersion}/changes';

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}/changes'

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}/changes'

response <- httr::GET(url)

output <- content(response)

Responses

Status	Description	Media Type	Schema
200	The changes for this data set version	application/json	DataSetVersionChangesViewModel
403	Forbidden	application/json	ProblemDetailsViewModel
404	Not Found	application/json	ProblemDetailsViewModel

Example successful response

{
  "majorChanges": {
    "filters": [
      {
        "currentState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "previousState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        }
      }
    ],
    "filterOptions": [
      {
        "filter": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "options": [
          {
            "currentState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            },
            "previousState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            }
          }
        ]
      }
    ],
    "geographicLevels": [
      {
        "currentState": {
          "code": "NAT",
          "label": "National"
        },
        "previousState": {
          "code": "NAT",
          "label": "National"
        }
      }
    ],
    "indicators": [
      {
        "currentState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "string",
          "decimalPlaces": 2
        },
        "previousState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "string",
          "decimalPlaces": 2
        }
      }
    ],
    "locationGroups": [
      {
        "currentState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        },
        "previousState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        }
      }
    ],
    "locationOptions": [
      {
        "level": {
          "code": "NAT",
          "label": "National"
        },
        "options": [
          {
            "currentState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            },
            "previousState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            }
          }
        ]
      }
    ],
    "timePeriods": [
      {
        "currentState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        },
        "previousState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        }
      }
    ]
  },
  "minorChanges": {
    "filters": [
      {
        "currentState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "previousState": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        }
      }
    ],
    "filterOptions": [
      {
        "filter": {
          "id": "BRlj4",
          "column": "school_type",
          "label": "School type",
          "hint": "Additional detail about the filter."
        },
        "options": [
          {
            "currentState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            },
            "previousState": {
              "id": "q1g3J",
              "label": "State-funded primary",
              "isAggregate": true
            }
          }
        ]
      }
    ],
    "geographicLevels": [
      {
        "currentState": {
          "code": "NAT",
          "label": "National"
        },
        "previousState": {
          "code": "NAT",
          "label": "National"
        }
      }
    ],
    "indicators": [
      {
        "currentState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "string",
          "decimalPlaces": 2
        },
        "previousState": {
          "id": "enW68",
          "column": "sess_authorised",
          "label": "Percentage of authorised sessions",
          "unit": "string",
          "decimalPlaces": 2
        }
      }
    ],
    "locationGroups": [
      {
        "currentState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        },
        "previousState": {
          "level": {
            "code": "NAT",
            "label": "National"
          }
        }
      }
    ],
    "locationOptions": [
      {
        "level": {
          "code": "NAT",
          "label": "National"
        },
        "options": [
          {
            "currentState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            },
            "previousState": {
              "id": "bOmZ4",
              "label": "Sheffield",
              "code": "E12000003"
            }
          }
        ]
      }
    ],
    "timePeriods": [
      {
        "currentState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        },
        "previousState": {
          "code": "AYQ1",
          "period": "2020/2021",
          "label": "2020/21 Q1"
        }
      }
    ]
  }
}