HoxtonAi
Powered by Redocly

Dwell Times

APIs to manage an Organisation's Dwell Time reports.

Create dwell time report

Create a report of dwell time for a given time range and given organisation

Securityo_auth
Request
Request Body schema: application/json
required

request dwell time data for an organisation and a given time range.

endDate
required
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

occupancyMonitorIds
Array of strings <uuid>

List of occupancy monitor ids in the report.

organisationId
required
string <uuid>
peopleCountMonitorIds
Array of strings <uuid>

List of people count monitor ids in the report.

startDate
required
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

413

Payload too large

422

unprocessable entity

500

failed

501

Not implemented.

post/dwell-time-reports
Request samples
application/json
{
  • "endDate": "2019-08-24",
  • "occupancyMonitorIds": [
    ],
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "peopleCountMonitorIds": [
    ],
  • "startDate": "2019-08-24"
}
Response samples
application/json
{
  • "createdAt": "string",
  • "dwellTimeReportId": "cc3abed8-7b0e-446e-98c2-20f9781cd5e6",
  • "endDate": "2019-08-24",
  • "errorMessage": "string",
  • "occupancyMonitorIds": [
    ],
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "peopleCountMonitorIds": [
    ],
  • "reportData": [
    ],
  • "startDate": "2019-08-24",
  • "status": "completed"
}

Get Dwell Time Report

Get a dwell time report identified by the provided report ID.

Securityo_auth
Request
path Parameters
dwellTimeReportId
required
string <uuid>

The full report ID of a report to be fetched.

Responses
200

OK.

401

Authentication failed.

403

Not allowed.

404

Not found.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

get/dwell-time-reports/{dwellTimeReportId}
Request samples 
Response samples 
application/json
{
  • "createdAt": "string",
  • "dwellTimeReportId": "cc3abed8-7b0e-446e-98c2-20f9781cd5e6",
  • "endDate": "2019-08-24",
  • "errorMessage": "string",
  • "occupancyMonitorIds": [
    ],
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "peopleCountMonitorIds": [
    ],
  • "reportData": [
    ],
  • "startDate": "2019-08-24",
  • "status": "completed"
}
List Dwell Time Reports
List of all dwell time reports for the given organisation


Securityo_auth 
Request 
query Parameters
organisationId
string <uuid> 
The ID of the associated organisation.


 
status
string
report status.


 Enum: "pending" "awaiting_approval" "approved" "rejected"  
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/dwell-time-reports
Request samples 
Response samples 
application/json
[
  • {
    }
]