{"openapi":"3.0.3","info":{"title":"AirSuite Customer APIs","version":"1.0.0","description":"\n\n<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 229.04 54.54\" fill=\"#132b25\" width=\"229\" style=\"max-width: 100%\">\n  <path d=\"M223.94,26.43V21.49h.82l1.73,4.07,1.73-4.07H229v4.94h-.82V23.24l-1.36,3.19h-.73l-1.36-3.14v3.14Zm-4.75-4.12v-.82h4.15v.82h-1.64v4.12h-.87V22.31Z\"></path>\n  <polygon points=\"50.81 53.96 45.08 53.96 45.08 27.78 25.41 8.11 5.74 27.78 5.74 53.96 0 53.96 0 25.41 25.41 0 50.81 25.41 50.81 53.96\"></polygon>\n  <polygon points=\"25.39 16.2 12.04 29.54 12.04 37.65 25.39 24.31 38.77 37.69 38.77 29.58 25.39 16.2\"></polygon>\n  <polygon points=\"25.39 32.46 12.04 45.8 12.04 53.91 25.39 40.57 38.77 53.95 38.77 45.84 25.39 32.46\"></polygon>\n  <path d=\"M71.6,41.66h8.79L76.66,31.18A17.64,17.64,0,0,1,76,28.69a22.59,22.59,0,0,1-.71,2.49ZM61.38,54,73.11,21.49h5.82L90.65,54h-6L82,46.46H69.91L67.29,54Z\"></path>\n  <path d=\"M93.94,32h5.42V54H93.94Zm-.62-7.68a3.29,3.29,0,1,1,3.33,3.29,3.29,3.29,0,0,1-3.33-3.29\"></path>\n  <path d=\"M118.72,37h-2c-3.91,0-6.35,2.09-6.35,6.35V54H105V32.07h5.11l.31,3.2a6.12,6.12,0,0,1,6-3.64,9.62,9.62,0,0,1,2.4.31Z\"></path>\n  <path d=\"M132.89,20.92c6.57,0,10.75,3.64,10.93,9.51h-5.69C138,27.62,136,26,132.8,26c-3.51,0-5.77,1.69-5.77,4.4,0,2.31,1.24,3.6,4,4.22l5.11,1.11c5.55,1.2,8.26,4,8.26,8.88,0,6-4.71,10-11.86,10-6.93,0-11.46-3.69-11.59-9.51h5.69c0,2.75,2.26,4.4,5.91,4.4s6.17-1.64,6.17-4.35c0-2.18-1.11-3.46-3.78-4l-5.15-1.16c-5.51-1.2-8.4-4.35-8.4-9.33,0-5.68,4.71-9.64,11.55-9.64\"></path>\n  <path d=\"M168.33,32V54h-5l-.4-2.93a8.58,8.58,0,0,1-7.11,3.51c-5.06,0-8-3.42-8-8.79V32h5.42V43.84c0,4.18,1.64,5.86,4.66,5.86,3.42,0,5.06-2,5.06-6.17V32Z\"></path>\n  <path d=\"M173.58,32H179V54h-5.42ZM173,24.34a3.29,3.29,0,1,1,3.33,3.29A3.29,3.29,0,0,1,173,24.34\"></path>\n  <polygon points=\"186.64 53.96 186.64 36.55 182.42 36.55 182.42 32.02 186.64 32.02 186.64 25.18 192.06 25.18 192.06 32.02 196.32 32.02 196.32 36.55 192.06 36.55 192.06 53.96 186.64 53.96\"></polygon>\n  <path d=\"M202.72,40.81h11c0-3-2.09-5-5.33-5s-5.15,1.73-5.69,5M197.43,43c0-6.88,4.49-11.64,10.93-11.64s10.75,4.4,10.75,11.24v1.64l-16.52,0c.4,3.86,2.44,5.82,6,5.82,3,0,4.93-1.16,5.55-3.24h5c-.93,4.8-4.93,7.68-10.66,7.68-6.53,0-11.1-4.75-11.1-11.55\"></path>\n</svg>\n\n\nThe following APIs can be used to retrieve your organisation&rsquo;s data\nusing an AirSuite API key.\n\nGenerate an API key from your\n[Organisation Settings](https://portal.airsuite.com/organisations) page.\n\n[HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Authentication#basic_authentication_scheme)\nis used to authenticate requests. Use your AirSuite Organisation UUID as the\nusername and your API key as the password.\n\nMissing something you need? Please [contact us](https://airsuite.com/contact).\n"},"components":{"schemas":{},"parameters":{}},"paths":{"/v0/deployments/{uuid}/name":{"post":{"summary":"Change deployment name","tags":["deployments"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"uuid","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":128},"required":false,"name":"name","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128}}}}}},"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"organisation":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"required":["name","uuid"]},"deployment":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"device":{"type":"integer","minimum":0},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]},"created":{"type":"string"}},"required":["name","uuid","device","location","created"]}},"required":["organisation","deployment"]}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}},"/v0/deployments":{"get":{"summary":"List deployments in the organisation","tags":["deployments"],"responses":{"200":{"description":"List of deployments","content":{"application/json":{"schema":{"type":"object","properties":{"organisation":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"required":["name","uuid"]},"deployments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"device":{"type":"integer","minimum":0},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]},"created":{"type":"string"}},"required":["name","uuid","device","location","created"]}}},"required":["organisation","deployments"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}},"/v0/devices":{"get":{"summary":"List devices in the organisation","tags":["devices"],"responses":{"200":{"description":"List of devices","content":{"application/json":{"schema":{"type":"object","properties":{"organisation":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"required":["name","uuid"]},"devices":{"type":"array","items":{"type":"object","properties":{"serial":{"type":"integer","minimum":0},"type":{"type":"string"},"model":{"type":"string","nullable":true},"last_contact":{"type":"string","nullable":true},"fw_version":{"type":"integer","nullable":true,"minimum":0},"target_fw_version":{"type":"integer","nullable":true,"minimum":0}},"required":["serial","type","model","last_contact","fw_version","target_fw_version"]}}},"required":["organisation","devices"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}},"/v0/n4l/sensors":{"get":{"summary":"Retrieves all sensors currently stored","description":"Equivalent of N4L /sensors API.\n\n> A sensor deployment is a wrapper around a vendor deployment / installation / installation location / device, and contains an identifier which is vendor specific, this being vendorId and an internal identifier for a given sensor which is _id","tags":["n4l"],"parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"default":50},"required":false,"name":"perPage","in":"query"},{"schema":{"type":"string","enum":["smooth","monkeytronics"]},"required":false,"name":"vendor","in":"query"}],"responses":{"200":{"description":"Paginated list of sensors","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"buildingId":{"type":"string","format":"uuid"},"buildingName":{"type":"string","nullable":true},"buildingNumber":{"type":"string"},"characteristics":{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"buildingOrientation":{"type":"string","nullable":true},"estimatedRoomHeight":{"type":"number","nullable":true},"heatingSystemType":{"type":"string","nullable":true},"numberOfStudents":{"type":"number","nullable":true,"minimum":0},"primarySourceExternalNoise":{"type":"string","nullable":true},"primarySourceInternalNoise":{"type":"string","nullable":true},"siteTopology":{"type":"string","nullable":true},"ventilationSystemType":{"type":"string","nullable":true},"windowOperation":{"type":"string","nullable":true},"windowOrientation":{"type":"string","nullable":true},"windowsOpenDuringVisit":{"type":"boolean","nullable":true}},"required":["_id","buildingOrientation","estimatedRoomHeight","heatingSystemType","numberOfStudents","primarySourceExternalNoise","primarySourceInternalNoise","siteTopology","ventilationSystemType","windowOperation","windowOrientation","windowsOpenDuringVisit"]},"customName":{"type":"string"},"dateOfFirstReading":{"type":"string","nullable":true,"format":"date-time"},"decile":{"type":"string","nullable":true},"device_serial":{"type":"string"},"deviceMac":{"type":"string","nullable":true},"deviceModel":{"type":"string"},"deviceModelType":{"type":"string"},"firmwareVersion":{"type":"string","nullable":true},"firstReadingsReceived":{"type":"boolean"},"floorId":{"type":"string","format":"uuid"},"floorName":{"type":"string"},"installerEmail":{"type":"string"},"installerName":{"type":"string"},"lastReadingCount":{"type":"integer","nullable":true,"minimum":0},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"ministryBuildingId":{"type":"string","nullable":true},"moeId":{"type":"integer","nullable":true,"minimum":0},"notes":{"type":"string"},"region":{"type":"string"},"roomId":{"type":"string","nullable":true,"format":"uuid"},"roomName":{"type":"string","nullable":true},"schoolId":{"type":"string","nullable":true,"format":"uuid"},"schoolName":{"type":"string","nullable":true},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE","PROBLEM","WARNING","NEW"]},{"allOf":[{"type":"string"},{"type":"object","properties":{}}]}]},"syncInProgress":{"type":"boolean"},"vendor":{"type":"string","enum":["smooth","monkeytronics","tether"]},"vendorId":{"type":"string"},"whenCreated":{"type":"string","format":"date-time"},"whenDeactivated":{"type":"string","nullable":true,"format":"date-time"},"whenFirstManualSyncTriggered":{"type":"string","nullable":true},"whenLastContacted":{"type":"string","format":"date-time"},"whenLastManualSyncTriggered":{"type":"string","nullable":true,"format":"date-time"},"whenLastReading":{"type":"string","nullable":true,"format":"date-time"},"whenUpdated":{"type":"string","format":"date-time"},"whoInstalledName":{"type":"string"},"whoTriggeredFirstManualSync":{"type":"string"},"whoTriggeredLastManualSync":{"type":"string"},"whoUpdated":{"type":"string"}},"required":["_id","buildingName","customName","dateOfFirstReading","device_serial","lastReadingCount","latitude","longitude","moeId","roomId","roomName","schoolId","schoolName","status","vendor","vendorId","whenCreated","whenDeactivated","whenLastReading","whenUpdated"]}},"meta":{"type":"object","properties":{"page":{"type":"integer","minimum":0},"perPage":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["page","perPage","total"]}},"required":["data","meta"]}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}},"/v0/organisations":{"get":{"summary":"List suborganisations in the organisation","tags":["organisations"],"responses":{"200":{"description":"List of suborganisations","content":{"application/json":{"schema":{"type":"object","properties":{"organisation":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"required":["name","uuid"]},"suborganisations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"required":["name","uuid"]}}},"required":["organisation","suborganisations"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}},"/v0/deployments/{uuid}/data":{"get":{"summary":"Get data collected by a deployment","description":"The v0 version of this API is deprecated and will be removed from January 2026. Use /v1/deployments/{uuid}/data instead.","deprecated":true,"tags":["deployments"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"uuid","in":"path"},{"schema":{"type":"string"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string"},"required":false,"name":"to","in":"query"}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"organisation":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"}},"required":["name","uuid"]},"deployment":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"device":{"type":"integer","minimum":0},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]},"created":{"type":"string"}},"required":["name","uuid","device","location","created"]},"data":{"type":"object","properties":{"interval_start":{"type":"integer","minimum":0},"interval_end":{"type":"integer","minimum":0},"records":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0},"interval_start":{"type":"integer","minimum":0},"interval_end":{"type":"integer","minimum":0},"data":{"type":"object","additionalProperties":{"type":"number"}}},"required":["sequence","interval_start","interval_end","data"]}}},"required":["interval_start","interval_end","records"]}},"required":["organisation","deployment","data"]}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}},"/v0/healthcheck":{"get":{"summary":"Internal service health-check","tags":["healthcheck"],"responses":{"200":{"description":"Service status information","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","minimum":0,"exclusiveMinimum":true},"statusDb1":{"anyOf":[{"type":"string","enum":["ok"]},{"type":"string","enum":["error"]}]},"statusDb2":{"anyOf":[{"type":"string","enum":["ok"]},{"type":"string","enum":["error"]}]}},"required":["status","statusDb1","statusDb2"]}}}},"503":{"description":"Service is unavailable due to database unreachability","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","minimum":0,"exclusiveMinimum":true},"statusDb1":{"anyOf":[{"type":"string","enum":["ok"]},{"type":"string","enum":["error"]}]},"statusDb2":{"anyOf":[{"type":"string","enum":["ok"]},{"type":"string","enum":["error"]}]}},"required":["status","statusDb1","statusDb2"]}}}}}}},"/v0/n4l/sensors/{uuid}/readings":{"get":{"summary":"Retrieves the readings for a given sensor","description":"Equivalent of N4L /sensors/{identifier}/readings API.\n\n> Returns the readings for a given sensor. By default calling without toDateTime and fromDateTime will return the most recent 50 readings.","tags":["n4l"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"The N4L sensor identifier (_id)"},"required":true,"description":"The N4L sensor identifier (_id)","name":"uuid","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"fromDateTime","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":10000,"default":50},"required":false,"name":"perPage","in":"query"},{"schema":{"type":"string"},"required":false,"name":"searchAfter","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"toDateTime","in":"query"}],"responses":{"200":{"description":"Paginated list of readings","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"dateTime":{"type":"string","format":"date-time"},"temperature":{"type":"number"},"humidity":{"type":"number"},"co2":{"type":"number"},"sound":{"type":"number"},"light":{"type":"number"},"motion":{"type":"number"},"roomId":{"type":"string","nullable":true,"format":"uuid"},"sensorId":{"type":"string","format":"uuid"},"sensorName":{"type":"string"},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"sensorVendor":{"type":"string","enum":["smooth","monkeytronics","tether"]},"moeId":{"type":"integer","nullable":true,"minimum":0},"schoolName":{"type":"string","nullable":true},"schoolId":{"type":"string","nullable":true,"format":"uuid"},"roomName":{"type":"string"},"buildingId":{"type":"string","format":"uuid"},"buildingName":{"type":"string","nullable":true},"ministryBuildingId":{"type":"string","nullable":true},"buildingNumber":{"type":"string","nullable":true},"floorName":{"type":"string"},"floorId":{"type":"string","format":"uuid"}},"required":["_id","dateTime","roomId","sensorId","sensorName","latitude","longitude","sensorVendor","moeId","schoolName","schoolId"]}},"meta":{"type":"object","properties":{"searchAfter":{"type":"string","nullable":true},"perPage":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["searchAfter","perPage","total"]}},"required":["data","meta"]}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}},"/v1/deployments/{uuid}/data":{"get":{"summary":"Get data collected by a deployment, summarised by requested interval","tags":["deployments"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"uuid","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","enum":["raw","minute","5min","15min","hour","day"]},"required":false,"name":"interval","in":"query"}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"type":"object","properties":{"interval":{"type":"string","enum":["raw","minute","5min","15min","hour","day"]},"data":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"interval_end":{"type":"string","format":"date-time"}},"required":["interval_end"]},{"type":"object","additionalProperties":{"type":"number","nullable":true}}]}}},"required":["interval","data"]}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"401":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}},"403":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false]},"error":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"fatal":{"type":"boolean"},"message":{"type":"string"}},"required":["message"]}}},"required":["ok","error"]}}}}}}}}}