Skip to main content

DataSetLatestVersionViewModel

Provides high-level information about the latest version of a data set.

Properties

Property Type Required Description
version string true

The version number. Follows semantic versioning e.g. 2.0 (major), 1.1 (minor).
published string true

When the version was published.
totalResults integer true

The total number of results available to query in the data set.
file DataSetVersionFileViewModel true

The file that this data set version is based on.
timePeriods TimePeriodRangeViewModel true

The time period range covered by the data set.
geographicLevels array (string) true

The geographic levels available in the data set.

Allowed options for child items:

  • English devolved area
  • Local authority
  • Local authority district
  • Local enterprise partnership
  • Local skills improvement plan area
  • Institution
  • Mayoral combined authority
  • MAT
  • National
  • Opportunity area
  • Parliamentary constituency
  • Provider
  • Regional
  • RSC region
  • School
  • Sponsor
  • Ward
  • Planning area
filters array (string) true

The filters available in the data set.
indicators array (string) true

The indicators available in the data set.

Example schema

{
  "version": "2.0",
  "published": "2024-03-01T09:30:00+00:00",
  "totalResults": 1000000,
  "file": {
    "id": "e0754872-3206-4918-aad4-029eaaae191f"
  },
  "timePeriods": {
    "start": "2024 January",
    "end": "2024 December"
  },
  "geographicLevels": [
    "NAT",
    "REG",
    "LA"
  ],
  "filters": [
    "Characteristic",
    "School type"
  ],
  "indicators": [
    "string"
  ]
}