Get Zone Statistics

View Zone statistics for all Clients included in the Area.

{ "trID": "20250212174827129876", "resultCode": "0200", "resultMsg": "string", "errMsg": "string", "cursor": "string", "resultData": [ { "time": "2019-08-24T14:15:22Z", "key": "string", "metric": "levelCount", "value": 0 } ] }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

dates

array[string]

required

The time value is UTC and follows ISO8601.

Example:

["2024-11-13T15:00:00Z","2024-11-14T15:00:00Z"]

timeUnit

enum<string>

required

Default is required, but can be omitted if metric is avgTime

Allowed values:

minutehourday

Example:

minute

metric

enum<string>

required

Allowed values:

levelCountlevelCountSumcongestionLevelpassingCountpassingCountSumavgTimeavgTimeAvgavgVelocity

Example:

levelCount

congestionLevel

integer

optional

Required if the metric is levelCountSum.

Example:

Body Params application/x-www-form-urlencoded

object {0}

Responses

🟢200Success

application/json

Body

trID

string <YYYYMMDDhhmmssnnxxxx>

required

YYYYMMDDhhmmssminnnn

Example:

20250212174827129876

resultCode

enum<string>

required

0200

Allowed values:

020014011429

resultMsg

string

required

Request OK

errMsg

string | null

optional

Error Messsage if exists

cursor

string

required

Encoded cursor information, generated by pagination only

resultData

array[object (ChartZoneStat) {4}]

required

time

string <date-time>

required

Each time value corresponding to the lookup period

key

string

required

key name based on the lookup item

metric

enum<string>

required

Statistics lookup item

Allowed values:

levelCountlevelCountSumcongestionLevelpassingCountpassingCountSumavgTimeavgTimeAvgavgVelocity

value

integer

required

The value of the lookup item