Get Dwell Time Report

Request

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

Security

api_key

Path

dwellTimeReportIdstring, (uuid)required

The full report ID of a report to be fetched.

curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/dwell-time-reports/{dwellTimeReportId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

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"

Response

{
  "createdAt": "string",
  "dwellTimeReportId": "cc3abed8-7b0e-446e-98c2-20f9781cd5e6",
  "endDate": "2019-08-24",
  "errorMessage": "string",
  "occupancyMonitorIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  "peopleCountMonitorIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "reportData": [
    { … }
  ],
  "startDate": "2019-08-24",
  "status": "completed"
}