Skip to content

Dwell Times

APIs to manage an Organisation's Dwell Time reports.

Operations

List Dwell Time Reports

Request

List of all dwell time reports for the given organisation

Security
api_key
Query
organisationIdstring, (uuid)

The ID of the associated organisation.

statusstring

report status.

Enum:"pending""awaiting_approval""approved""rejected"
includeInactiveOrgsboolean

When true, include resources of inactive (disabled or churned) organisations. Only honoured for callers with the corresponding :all permission.

Default:false
curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/dwell-time-reports?organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=pending&includeInactiveOrgs=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
createdAtstring, (datetime)
dwellTimeReportIdstring, (uuid)
endDatestring, (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

errorMessagestring

error in dwell time report.

occupancyMonitorIdsArray of strings, (uuid)

List of occupancy monitor ids in the report.

organisationIdstring, (uuid)
peopleCountMonitorIdsArray of strings, (uuid)

List of people count monitor ids in the report.

reportDataArray of objects(DwellTimeData)
startDatestring, (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

statusstring
Enum:"completed""completed_with_errors""pending"
warningsArray of objects(DwellTimeWarning)

Monitors or days that are missing from reportData, and why.

]
Response
[
  {
    "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",
    "warnings": [ … ]
  }
]