OFoffice-of-national-statistics
Private

Get a list of dataset series that have unpublished versions

Changed on

Get a list of dataset series that have unpublished versions. This is used to easily determine versions/editions of series that are awaiting publication.

get/dataset-editions

Request

  • Base URL
    https://api.beta.ons.gov.uk/v1
  • Auth
    API key in header Authorization

Query parameters

statestring

A state value to filter on (e.g. ‘published’)

publishedboolean

A boolean value which indicates whether to include published editions/versions in the response

limitinteger

Maximum number of items that will be returned. A value of zero will return zero items.

offsetinteger

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.

Response

A json list containing all dataset editions that have unpublished versions

dataset_idstring required

The unique identifier for a dataset.

The dataset ID cannot be changed once the series is first published.

titlestring required

The title of the dataset

descriptionstring required

The description of the dataset

editionstring required

The unique identifier for an edition of a dataset. The edition ID cannot be changed once first published. If a subsequent version of the edition attempts to change the edition ID, they will be treated as the first version of a new edition instead.

edition_titlestring required

The human readable title of the edition

release_datestring date-time required

The release date of the this version of the dataset edition

state'created' | 'completed' | 'failed' | 'edition-confirmed' | 'associated' | 'published' required

The state of the resource, can only be one of the following:

  • created
  • completed (instances only)
  • failed (instances only)
  • edition-confirmed (instances and versions only)
  • associated (not editions)
  • published

Example response

[
  {
    "dataset_id": "my-dataset",
    "title": "Consumer Prices Index",
    "description": "CPIH is the most comprehensive measure of inflation. It extends CPI to include a measure of the costs associated with owning, maintaining and living in one's own home, known as owner occupiers' housing costs (OOH), along with council tax. This dataset provides CPIH time series (2005 to latest published month), allowing users to customise their own selection, view or download.",
    "edition": "july-september-2017",
    "edition_title": "January 2025",
    "latest_version": {
      "href": "https://api.beta.ons.gov.uk/v1/datasets/my-dataset/editions/july-september-2017/versions/5",
      "id": "5"
    },
    "state": "published"
  }
]

Changes