Welcome to the Leapcraft Client API. This API includes REST methods to fetch information about Leapcraft devices.
\nHere's an introduction to the entities in the Leapcraft ecosystem and the flow of how to interact with the API.
\nAPI KEY: A key issued to every client and is unique to every client. Please ensure this key is protected. Contact our support should you rotate the keys.
\nTopology: Typically, our sensing devices are connected to a central device, known as the hub. Topology defines the relationship between the sensing devices and the hub that's posting data to our cloud infrastructure
\nDevice: Is one of our sensing hardware, including AirBird, Mininode, Ambinode, CPHSense that measures air quality metrics.
\nThe API is secured using the API KEY. API methods require an Authorization token header to be set. Every client is issued a unique API KEY that can be used to exchange transactional authorization tokens to interact with the API.
\nThe following information can be retrieved through the API.
\nTopologies: All the topologies that are deployed at a client's location(s)
\nTopology: The devices that are part of a specific topology
\nDevice: The specifics of a particular device
\nAverages: Averages of time series air quality metrics at several resolutions, queried by a time range.
\nThe available resolution options are:
\n\"daily\": Average of samples in minutes resolution, the actual resolution is dynamic and based on a devices' posting interval.
\n\"weekly\": Average of samples every hour
\n\"monthly\": Averages of the samples every day
\nAll times are in UTC and the created_at field indicates the end time of the respective resolution.
Notifications: List of notifications that were generated for a specific device. Notifications usually belong to one of the following 2 categories:
\ntechnicalAlert: Notifications that are technical in nature e.g., if a device's battery is down
\nliveRecommendation: These notifications are specific to air quality in the vicinity of a specific device e.g., high CO2 levels
\nThe GET method has additional querying options to fetch the notifications. Please refer to the examples and the description in the GET method's documentation
\nGet a transactional token for an API KEY
\n","urlObject":{"path":["auth","client","token"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8548c1bf-b314-4845-b9e0-8467ec0554bf","name":"Get token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","type":"text","value":"abcd1234"}]},"url":"{{BASE_URL}}/auth/client/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 May 2021 17:15:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"0a559205050000e25b2e181000000001"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v2?s=v5Z0BwII%2BFZ4DZX7AGjg7kC6ZcM7lNXEgZaFA59juFzGIJR2LtbRRQf1BlCS8PhjiEc97qXEkq1jaG8%2BFzuTaJYBhkrozDRi%2FzRMvAJLJN%2B6qc9sTq7%2FVYMwnnTQ97uY\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"65691f81aed2e25b-SIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"alt-svc","value":"h3-27=\":443\"; ma=86400, h3-28=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"bearer\",\n \"token\": \"9e65a545de443ccbe72c0bbfbe638f2fFJwyr15xdD2n9nKVh34hVsRGTWjviPP6A84z/8tzIsSkmu1dPBoCzuj6FUgLvnKA\"\n}"}],"_postman_id":"b653f6de-c42d-4c53-9a36-f2cc17c804a0"}],"id":"1dd3a8d5-b03f-49a8-9a5b-d5472111c208","_postman_id":"1dd3a8d5-b03f-49a8-9a5b-d5472111c208","description":""}],"id":"a342957f-6311-4ca8-9ef0-de97bd93058e","description":"","event":[{"listen":"prerequest","script":{"id":"b3cb93ea-fa6c-44d0-b0c4-4f99b0d8681f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"223980cc-fe3b-4d3e-8ef3-3bd3826415e7","type":"text/javascript","exec":[""]}}],"_postman_id":"a342957f-6311-4ca8-9ef0-de97bd93058e"},{"name":"Topology","item":[{"name":"Get all topologies","id":"2a934300-9e2c-4916-b732-57d76dd372b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get all notifications generated for devices. This method accepts physical_id, limit, offset query parameters. The limit is capped at 50. If the offset parameter is set, the limit will apply from the offset value. By default, the notifications are ordered by descending order of time.