Facility

Endpoints


Generate heatmaps of a facility

POST/facilities/:facilityId/heatmap

Arguments

HEADERS
  • Authorization
    • Basic authentication with API Key
QUERY STRING PARAMETERS
  • facilityId UUID required id of the target facility to generate heatmaps
  • interval Enum required
    • daily
    • weekly
    • monthly The time interval to generate heatmaps
  • nthOfYear Int optional Specific date identifier to generate heatmaps. Can be week number or month number.
  • year Int optional Year identifier to generate heatmaps

Returns

Returns a success message

{
"status": "ok",
"message": "Heatmap generation started"
}