Dataset API Explorer

Dataset	N/A
Service API	B
Data / Layer	C

Query Parameters

Name

Description

srsName

Return geometries in the selected Coordinate Reference System (CRS). If no CRS is specified, the dataset’s native CRS will be used.

- WGS84 (World Geodetic System 1984); or
- HK1980 (Hong Kong 1980 Grid System)

Define the bounding box with the minimum and maximum coordinates. Default values are set to encompass the Hong Kong region.

Min X: Longitude (East) / Easting Coordinate
Min Y: Latitude (North) / Northing Coordinate
Max X: Longitude (East) / Easting Coordinate
Max Y: Latitude (North) / Northing Coordinate

Min X:

Min Y:

Max X:

Max Y:

Right Click and drag on map to input coordinates by map.

count

To specify the maximum number of records to be returned.

Remarks: The specified value should be equal to or smaller than the system threshold (the current threshold is 10,000 and may be adjusted where appropriate). Please examine the API response for details.

startIndex

To specify the index of the first record in the response. This parameter is commonly used in conjunction with “count” to retrieve a number of records within a large dataset.

filter

To query records according to specific data field name and field value. The input value is case sensitive and wildcard (%) character is supported for string field(s). The datetime field(s) support the following formats: YYYY/MM/DD, YYYY/MM, MM/YYYY, DD/MM/YYYY.
Field Name:

Statistics

To provide statistics result for the query.
Statistic Type: On statistic field name:
Group By:

Help

Assume there are data records as follow:

Name	Team	Ages	Salary
Abby	A	18	100
Bob	B	25	250
Charlie	B	65	1000
Dog	A	2	null
Ella	A	46	500

Count how many person(name) that each team has.
Choose Statistic Type [Count], Group By [Team], on Statistic field name [Name]
Result will be: Team [A], Name_count_result: 3; Team [B], Name_count_result: 2

Count how many person(name) for each team that has salary.
Choose Statistic Type [Count], Group By [Team], on Statistic field name [Salary] *Note: null value won't be counted
Result will be: Team [A], Salary_count_result: 2; Team [B], Salary_count_result: 2

Count how many person(name) that age is smaller than 30 for each team.
Choose Statistic Type [Count], Group By [Team], on Statistic field name [Name], with Data Field Name [Ages < 30]
Result will be: Team [A], Name_count_result: 2; Team [B], Name_count_result: 1

Total sum of salary for each team.
Choose Statistic Type [Total Sum], Group By [Team], on Statistic field name [Salary]
Result will be: Team [A], Salary_sum_result: 600; Team [B], Salary_sum_result: 1250

Average salary for each team.
Choose Statistic Type [Average], Group By [Team], on Statistic field name [Salary]
Result will be: Team [A], Salary_average_result: 200; Team [B], Salary_average_result: 625

Average age for each team.
Choose Statistic Type [Average], Group By [Team], on Statistic field name [Age]
Result will be: Team [A], Age_average_result: 22; Team [B], Age_average_result: 45

API Query Service URL

Click to Copy text

Response and Status Codes