Populationdensitydata
Population Density Data
Retrieves population density information in a specified area
ModelsExpand Collapse
PopulationdensitydataRetrieveResponse object { status, timedPopulationDensityData, statusInfo } Population density values is represented in time intervals for different cells of the requested area. Each element in timedPopulationDensityData array corresponds to a time interval, containing population density data for the grid cells. The intervals are 1 hour long.
Population density values is represented in time intervals for different cells of the requested area. Each element in timedPopulationDensityData array corresponds to a time interval, containing population density data for the grid cells. The intervals are 1 hour long.
status: "SUPPORTED_AREA" or "PART_OF_AREA_NOT_SUPPORTED" or "AREA_NOT_SUPPORTED" or "OPERATION_NOT_COMPLETED"Represents the state of the response for the input polygon defined in the request, the possible values are:
SUPPORTED_AREA: The whole request area is supported. Population density data for the entire requested area is returned.PART_OF_AREA_NOT_SUPPORTED: Part of the requested area is outside the MNOs coverage area, the cells outside the coverage
area will have property dataType with value NO_DATA.AREA_NOT_SUPPORTED: The whole requested area is outside the MNOs coverage area. No data will be returned.OPERATION_NOT_COMPLETED: An error happened during asynchronous processing of the request. This status will only be returned
in case the asynchronous API behaviour is used.
Represents the state of the response for the input polygon defined in the request, the possible values are:
SUPPORTED_AREA: The whole request area is supported. Population density data for the entire requested area is returned.PART_OF_AREA_NOT_SUPPORTED: Part of the requested area is outside the MNOs coverage area, the cells outside the coverage area will have propertydataTypewith valueNO_DATA.AREA_NOT_SUPPORTED: The whole requested area is outside the MNOs coverage area. No data will be returned.OPERATION_NOT_COMPLETED: An error happened during asynchronous processing of the request. This status will only be returned in case the asynchronous API behaviour is used.
timedPopulationDensityData: array of object { cellPopulationDensityData, endTime, startTime } Time ranges along with the population density data for the cells within it.
The request startTime or the request endTime have to be fully covered by the intervals.
For example, if the intervals are 1-hour long and the input date range were [2024-01-03T11:25:00Z
to 2024-01-03T12:45:00Z] it would contain 2 intervals (Interval from 2024-01-03T11:00:00Z
to 2024-01-03T12:00:00Z and interval from 2024-01-03T12:00:00Z to 2024-01-03T13:00:00Z).
Time ranges along with the population density data for the cells within it. The request startTime or the request endTime have to be fully covered by the intervals. For example, if the intervals are 1-hour long and the input date range were [2024-01-03T11:25:00Z to 2024-01-03T12:45:00Z] it would contain 2 intervals (Interval from 2024-01-03T11:00:00Z to 2024-01-03T12:00:00Z and interval from 2024-01-03T12:00:00Z to 2024-01-03T13:00:00Z).
cellPopulationDensityData: array of object { dataType, geohash } Population density data for the different cells in a concrete time range.
Population density data for the different cells in a concrete time range.
Coordinates of the cell represented as a string using the Geohash system. Encoding a geographic location into a short string. The value length, and thus, the cell granularity, is determined by the request body property precision.
Interval end time. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd’T’HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
Interval start time. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd’T’HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)