Page Comparison

...

	
Successful Response

Media type

application/json
Controls Accept header.
Example Value
Schema
{
  "message": "string",
  "data": {
    "grouped_by": "projectzone",
    "grouped_by_interval": "5m6h",
    "data": [
      {
        "groupzone": {
          "capacity": 0,
          "id": 0,
          "name": "string"
        },
        "datetime": "string",
        "utilization": 0.01,
        "occupied": 0,
        "traffic_in": 0,
        "traffic_out": 0,
        "traffic_out": 0
      }
    ]
  },
  "reason": "ok"
}
      }
    ]
  },
  "reason": "ok"
}

As shown in the screenshot at the top of the page, this endpoint provides data that is suitable for both the Utilization History chart and the Traffic In|Out History chart. The API response includes a list of objects, with each object containing information about the parking hierarchy level (project/zone/level/group), the chosen grouping parameter (grouped_by), the grouping interval (grouped_by_interval), a timestamp (datetime), and occupancy data.

Here's a breakdown of the key fields in the API response:

• project/zone/level/group: This field describes the parking hierarchy object that has been selected for grouping based on the group_by query argument.

• grouped_by: Indicates the value of the group_by query argument, which determines how the data is grouped.

• grouped_by_interval: Specifies the value of the group_by_interval query argument, which defines the time interval for grouping.

• datetime: Represents the timestamp associated with the data entry.

• utilization: Indicates the average utilization rate, ranging from 0.00 to 1.00, for the specified period.

• occupied: Represents the number of occupied parking positions during the specified period.

• traffic_in: Indicates the number of vehicles that entered during the specified period.

• traffic_out: Represents the number of vehicles that exited during the specified period.

This data structure allows you to analyze and visualize parking utilization, traffic flow, and occupancy trends over time.

For more comprehensive details and usage examples, please refer to the API documentation.

...

{
  "message": "string",
  "data": {
    "grouped_by": "projectzone",
    "grouped_by_interval": "hourday",
    "data": [
      {
        "groupzone": {
          "capacity": 0,
          "id": 0,
          "name": "string"
        },
        "utilization": 0,
        "occupied": 0,
        "week_day": "mon",
        "time": "string"
      }
    ]
  },
  "reason": "ok"
}

...