/population-types/{population-type}/census-observations

GET

Parameters

Name Type Description
population-type path
dimensions query A comma separated list of dimensions to retrieve information for.
area-type query The name of the area-type dimension that is being flexed, e.g. country

Responses

200: Json object containing all metadata for a version

Example value
{
  "blocked_area_count": 0,
  "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