/datasets/{dataset_id}/editions/{edition}/versions/{version}/census-observations

GET

Get observations for a census dataset, with capability to flex and filter the data to the users need. If no area-type or dimension parameters are supplied then observations for the default area-type and dimensions are returned.

Parameters

Name Type Description
dataset_id path Id that represents a dataset
edition path An edition of a dataset
version path A version of a dataset
area-type query The name of the area-type dimension that is being flexed, e.g. country

Responses

200: Json object containing observations for a dataset

Example value
{
  "links": {
    "dataset_metadata": {
      "href": "string",
      "id": "string"
    },
    "self": {
      "href": "string",
      "id": "string"
    },
    "version": {
      "href": "string",
      "id": "string"
    }
  },
  "observations": [
    {
      "dimensions": [
        {
          "dimension": "string",
          "dimension_id": "string",
          "option": "string",
          "option_id": "string"
        }
      ],
      "observation": 0
    }
  ],
  "total_observations": 0
}

400: Invalid request, reasons can be one of the following: * query parameters contain incorrect dimensions

404: Resource not found, reasons can be one of the following: * dataset id was incorrect * edition was incorrect * version was incorrect * observations not found for selected query paramaters

500: Failed to process the request due to an internal error