OpenSensors Analytics API
A collection of methods used to retrieve sensor data for your project
A collection of methods used to retrieve sensor data for your project
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/opensensors:opensensors-analytics-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: OpenSensors.com public Analytics API
version: 1.0.0
description: Documentatation for the Opensensors API. To authentiate and use our API please refer to the login and refresh endpoints
servers:
- url: https://api.opensensors.com/
tags:
- name: Analytics
description: A collection of methods used to retrieve sensor data for your project
paths:
/getBookingReservations:
get:
tags:
- Analytics
description: Get a list of booking reservations for a specific period and projectUri. Requires Authorization header to be set to a valid token issued by OpenSensors.
parameters:
- name: fromDate
description: ISO date string which represents the start of the date range for which data is requested
in: query
required: true
schema:
type: string
- name: toDate
description: ISO date string which represents the end of the date range for which data is requested
in: query
required: true
schema:
type: string
- name: projectUri
description: String which represents the unique identifier for the project the data is pulled from
in: query
required: true
schema:
type: string
responses:
'200':
description: This is an example response. nextCursor and lastCusor are used to navigate between a large number of devices
content:
application/json:
schema:
type: object
properties:
total:
type: integer
items:
type: array
example:
total: 2
items:
- Asset-Name: Desk 1
Floor: Floor 1
bookedFor: User 1
bookedBy: User 2
status: cancelled
autoCancelled: true
created: 1770642000000
startTime: 1770645600000
endTime: 1770649200000
recurringId: abcdef
- Asset-Name: Desk 2
Floor: Floor 1
bookedFor: User 2
bookedBy: User 2
status: confirmed
autoConfirmed: false
created: 1770642000000
startTime: 1770645600000
endTime: 1770649200000
summary: Get get booking reservations
x-summary-source: derived
operationId: getGetBookingReservations
x-operation-id-source: derived
/getDevicesAnalytics:
get:
tags:
- Analytics
description: Get analytics per device given from and to date and projectUri. Requires Authorozation header to be set to a valid token issued by OpenSensors.
parameters:
- name: fromDate
description: ISO date string which represents the start of the date range (dates are in GMT)
in: query
required: true
schema:
type: string
- name: toDate
description: ISO date string which represents the end of the date range (dates are in GMT)
in: query
required: true
schema:
type: string
- name: projectUri
description: String which represents the unique identifier for the project the data is pulled from
in: query
required: true
schema:
type: string
- name: tags
description: Comma-separated list of strings which represents the tags for the devices the data is pulled from
in: query
required: false
schema:
type: string
- name: size
description: Number which represents how many devices are going to be pulled. If total is greater than size, the response will contain a cursor that can be used to pull the next set of devices. Default value is 10.
in: query
required: false
schema:
type: string
- name: categories
description: Comma-separated list of strings which represents the categories of requested devices (meeting, desk, footfall, etc)
in: query
required: false
schema:
type: string
- name: interval
description: Length of intervals for occupancy over time. Possible values - 10m, hour, day, week, month. Defaults to one hour.
in: query
required: false
schema:
type: string
- name: cursor
description: Number which is used to navigate between a large number of devices
in: query
required: false
schema:
type: string
responses:
'200':
description: This is an example response. nextCursor and prevCusor are used to navigate when total number of devices is larger than the size parameter.
content:
application/json:
schema:
type: object
properties:
nextCursor:
type: string
lastCursor:
type: string
total:
type: integer
items:
type: array
example:
nextCursor: ff-ff
lastCursor: aa-aa
total: 1
items:
- sensorId: ff-ff-ff-ff-ff-ff-ff-ff
tags:
- Floor 1
- Desk 1
peakOccupancy:
value: 1
date: 1770768000000
avgOccupancy: 0.44
name: Desk 1
tagGroups:
Floor: Floor 1
avgOccupancyOverTime:
- - 1770681600000
- 1
- - 1770685200000
- 1
- - 1770688800000
- 0
summary: Get get devices analytics
x-summary-source: derived
operationId: getGetDevicesAnalytics
x-operation-id-source: derived
/getDevicesData:
get:
tags:
- Analytics
description: Get data per device for a specific date and projectUri. Requires Authorization header to be set to a valid token issued by OpenSensors.
parameters:
- name: date
description: ISO date string which represents the date for which data is requested
in: query
required: true
schema:
type: string
- name: projectUri
description: String which represents the unique identifier for the project the data is pulled from
in: query
required: true
schema:
type: string
- name: cursor
description: Identifier used to navigate between a large number of devices
in: query
required: false
schema:
type: string
responses:
'200':
description: This is an example response. nextCursor and lastCusor are used to navigate between a large number of devices
content:
application/json:
schema:
type: object
properties:
nextCursor:
type: string
lastCursor:
type: string
total:
type: integer
items:
type: array
example:
nextCursor: ff-ff
lastCursor: aa-aa
total: 1
items:
- Asset-Name: Desk 1
Floor: Floor 1
type: PIR
data:
- date: 1770642000000
formattedDate: 02/10/2026 00:00
occupied: false
- date: 1770645600000
formattedDate: 02/10/2026 01:00
occupied: false
- date: 1770649200000
formattedDate: 02/10/2026 02:00
occupied: true
summary: Get get devices data
x-summary-source: derived
operationId: getGetDevicesData
x-operation-id-source: derived
/getProjectMessages:
get:
tags:
- Analytics
description: Get messages given from and to date and projectUri. Requires Authorization header to be set to a valid token issued by OpenSensors.
parameters:
- name: fromDate
description: ISO date string which represents the start of the date range (dates are in GMT)
in: query
required: true
schema:
type: string
- name: toDate
description: ISO date string which represents the end of the date range (dates are in GMT)
in: query
required: true
schema:
type: string
- name: projectUri
description: String which represents the unique identifier for the project the data is pulled from
in: query
required: true
schema:
type: string
- name: projectUri
description: String which represents the unique identifier for the device the data is pulled from
in: query
required: false
schema:
type: string
- name: size
description: Number which represents how many messages are going to be pulled. If total is greater than size, then we will return you a cursor with which you can pull the next items. This value defaults to 100
in: query
required: false
schema:
type: string
- name: type
description: String which represents the sensor type messages being pulled
in: query
required: false
schema:
type: string
- name: cursor
description: Number which is used to navigate between large amounts of messages
in: query
required: false
schema:
type: string
responses:
'200':
description: This is an example response. nextCursor and prevCusor are used to navigate when total number of items is larger than the size parameter.
content:
application/json:
schema:
type: object
properties:
nextCursor:
type: integer
lastCursor:
type: integer
total:
type: integer
items:
type: array
items:
$ref: '#/components/schemas/Message'
summary: Get get project messages
x-summary-source: derived
operationId: getGetProjectMessages
x-operation-id-source: derived
/getProjects:
get:
tags:
- Analytics
description: Get list of projectUris. Requires Authorization header to be set to a valid token issued by OpenSensors.
responses:
'200':
description: This is an example response.
content:
application/json:
schema:
type: array
items:
type: string
summary: Get get projects
x-summary-source: derived
operationId: getGetProjects
x-operation-id-source: derived
components:
schemas:
Message:
type: object
properties:
date:
type: integer
rssi:
type: integer
lowBattery:
type: boolean
heartbeat:
type: boolean
lsnr:
type: integer
id:
type: string
type:
type: string
deviceId:
type: string
tags:
type: array
items:
type: string