HoxtonAi
Powered by Redocly

Reports

APIs to manage an Organisation's monitor reports.

Create aggregated api metrics report

Create a report of aggregated api request metrics for a given time range and list of organisations.

Securityo_auth
Request
Request Body schema: application/json
required

request aggregated api request metrics data for a set of orgs and a given time range.

clientIds
Array of strings

A list of IDs of the clients to fetch the data for.

endDate
string <date>

It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1

startDate
string <date>

It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1

Responses
200

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

422

Unprocessable entity.

500

Failed.

post/aggregated-api-request-metrics-reports
Request samples
application/json
{
  • "clientIds": [
    ],
  • "endDate": "2019-08-24",
  • "startDate": "2019-08-24"
}
Response samples
application/json
[
  • {
    }
]

Create aggregated video metrics report

Create a report of aggregated camera metrics for a given time range and list of cameras.

Securityo_auth
Request
Request Body schema: application/json
required

request aggregated video metrics data for a set of cameras and a given time range.

cameraIds
Array of strings <uuid>

A list of IDs of the cameras to fetch the data for.

endDate
string <date>

It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1

startDate
string <date>

It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1

timeGrain
string
Default: "24h"

The time granularity of the response.

Enum: "1h" "24h" "168h"
Responses
200

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

422

Unprocessable entity.

500

Failed.

post/aggregated-video-metrics-reports
Request samples
application/json
{
  • "cameraIds": [
    ],
  • "endDate": "2019-08-24",
  • "startDate": "2019-08-24",
  • "timeGrain": "1h"
}
Response samples
application/json
[
  • {
    }
]

Create live occupancy report

Create a report of live occupancies for a list of occupancy monitors.

Securityo_auth
Request
Request Body schema: application/json

request live occupancies for a list of occupancy monitors.

occupancyMonitorIds
Array of strings or null <uuid>

List of occupancy monitor ids in the report.

organisationIds
Array of strings or null <uuid>

List of organisation ids in the report.

siteIds
Array of strings or null <uuid>

List of site ids in the report.

Responses
200

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

422

Unprocessable entity.

500

Failed.

post/live-occupancy
Request samples
application/json
{
  • "occupancyMonitorIds": [
    ],
  • "organisationIds": [
    ],
  • "siteIds": [
    ]
}
Response samples
application/json
[
  • {
    }
]

Create occupancy report

Create a report of occupancy counts for a given time range and set of monitors.

Securityo_auth
Request
Request Body schema: application/json
required

request occupancy data for a set of monitors and a given time range.

endDate
string <date>

It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1.

isOpen
boolean
Default: false

Flag to filter output within site opening hour window

limit
integer

Number of rows of returned data. A 0 value returns all rows in the requested time range.

metrics
Array of strings

List of metrics associated with the monitors.

Items Enum: "occupancy_avg" "occupancy_max" "in_count_sum" "out_count_sum"
occupancyMonitorIds
Array of strings <uuid>

List of occupancy monitor ids in the report. At least one id is required.

startDate
string <date>

It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1.

timeGrain
string
Default: "1m"

The time window in the requested range for data aggregation.

Enum: "1m" "5m" "15m" "30m" "1h" "6h" "24h"
Responses
200

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

413

Payload too large.

422

Unprocessable entity.

500

Failed.

post/occupancy-reports
Request samples
application/json
{
  • "endDate": "2019-08-24",
  • "isOpen": false,
  • "limit": 0,
  • "metrics": [
    ],
  • "occupancyMonitorIds": [
    ],
  • "startDate": "2019-08-24",
  • "timeGrain": "1m"
}
Response samples
application/json
[
  • {
    }
]

Create peel off report

Create a peel off report for a given time range and set of monitors.

Securityo_auth
Request
Request Body schema: application/json
required

request peel off data for a set of monitors and a given time range.

endDate
string <date>

It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1. If provided will take precedence over endAt.

isOpen
boolean
Default: false

Flag to filter output within site opening hour window

peelOffMonitorIds
Array of strings <uuid>

List of peel off monitor ids in the report. At least one id is required.

startDate
string <date>

It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1.

timeGrain
string
Default: "1h"

The time window in the requested range to for data aggregation.

Enum: "1s" "1m" "5m" "15m" "30m" "1h" "6h" "24h"
Responses
200

OK

400

bad request

401

Authentication failed.

403

not allowed

413

Payload too large

422

unprocessable entity

500

failed

post/peel-off-reports
Request samples
application/json
{
  • "endDate": "2019-08-24",
  • "isOpen": false,
  • "peelOffMonitorIds": [
    ],
  • "startDate": "2019-08-24",
  • "timeGrain": "1s"
}
Response samples
application/json
[
  • {
    }
]

Create people count report

Create a report of people counts for a given time range and set of monitors.

Securityo_auth
Request
Request Body schema: application/json
required

request people count data for a set of monitors and a given time range.

endDate
string <date>

It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1.

isOpen
boolean
Default: false

Flag to filter output within site opening hour window

peopleCountMonitorIds
Array of strings <uuid>

List of people count monitor ids in the report. At least one id is required.

startDate
string <date>

It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1.

timeGrain
string
Default: "1h"

The time window in the requested range to for data aggregation.

Enum: "1s" "1m" "5m" "15m" "30m" "1h" "6h" "24h"
Responses
200

OK

400

bad request

401

Authentication failed.

403

not allowed

413

Payload too large

422

unprocessable entity

500

failed

post/people-count-reports
Request samples
application/json
{
  • "endDate": "2019-08-24",
  • "isOpen": false,
  • "peopleCountMonitorIds": [
    ],
  • "startDate": "2019-08-24",
  • "timeGrain": "1s"
}
Response samples
application/json
[
  • {
    }
]