/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
{
"description": "An object containing information on a list of observations for a given version of a census dataset - updated response",
"type": "object",
"properties": {
"links": {
"description": "A list of links related to this observation resource",
"type": "object",
"properties": {
"dataset_metadata": {
"properties": {
"href": {
"description": "link to resource",
"type": "string"
},
"id": {
"description": "id of resource",
"type": "string"
}
}
},
"self": {
"properties": {
"href": {
"description": "link to resource",
"type": "string"
},
"id": {
"description": "id of resource",
"type": "string"
}
}
},
"version": {
"properties": {
"href": {
"description": "link to resource",
"type": "string"
},
"id": {
"description": "id of resource",
"type": "string"
}
}
}
},
"readOnly": true
},
"observations": {
"description": "A list of dimensions for the given query",
"type": "array",
"items": {
"description": "An object containing information on a list of observations for a given version of a census dataset - updated response",
"type": "object",
"properties": {
"dimensions": {
"description": "A list of dimensions for the given query",
"type": "array",
"items": {
"description": "A dimension returned relating to an observation",
"type": "object",
"properties": {
"dimension": {
"description": "The dimension description",
"type": "string"
},
"dimension_id": {
"description": "The dimension id",
"type": "string"
},
"option": {
"description": "The description of the option the observation relates to",
"type": "string"
},
"option_id": {
"description": "The id of the option the observation relates to",
"type": "string"
}
}
}
},
"observation": {
"description": "The observation relating to the combination of dimensions and options",
"type": "integer"
}
}
}
},
"total_observations": {
"description": "The number of observations found",
"type": "integer"
}
}
}
400: Invalid request, reasons can be one of the following: * query parameters contain incorrect dimensions
Example value
null
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
Example value
null
500: Failed to process the request due to an internal error
Example value
null