Download OpenAPI specification:Download
This service provides a layer of abstraction on top of the Density data API's.
It is intended for use by the general public.
Lists the percentage of completeness of floor data over the specified time period from [0-1]. Data Status API is available for floors with Open Area Sensors. With this information, you can determine whether historical metric data is ready to pull for the floor and spaces on the floor during the requested time period. For more information on how to interpret this data see: https://developers.density.io/understand_historical_data.
success
{- "end_date": "2024-06-28T23:59:59Z",
- "floor_ids": [
- "spc_12345678901",
- "spc_10987654321"
], - "start_date": "2024-06-28T00:00:00Z"
}{- "spc_10987654321": {
- "completion": 0.97
}, - "spc_12345678901": {
- "completion": 0.97
}
}Calculates the occupancy for a set of spaces or for all spaces in a portfolio.
request body input
success
request data was missing or invalid
unable to authorize the given bearer token
access to this api is not allowed
resource not found
unexpected error
{- "end_date": "2024-02-28T23:59:59Z",
- "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
], - "start_date": "2024-02-28T00:00:00Z",
- "time_resolution": "total"
}{- "spc_10987654321": {
- "avg": 1.5,
- "max": 2,
- "min": 1
}, - "spc_12345678901": {
- "avg": 1.5,
- "max": 2,
- "min": 1
}
}Calculates the time used for a set of spaces or for all spaces in a portfolio.
request body input
success
request data was missing or invalid
unable to authorize the given bearer token
access to this api is not allowed
resource not found
unexpected error
{- "end_date": "2024-02-28T23:59:59Z",
- "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
], - "start_date": "2024-02-28T00:00:00Z",
- "time_resolution": "total"
}{- "spc_10987654321": {
- "percentage": 0.5,
- "raw": 450000
}, - "spc_12345678901": {
- "percentage": 0.5,
- "raw": 450000
}
}Calculates the utilization for a set of spaces or for all spaces in a portfolio.
request body input
success
request data was missing or invalid
unable to authorize the given bearer token
access to this api is not allowed
resource not found
unexpected error
{- "end_date": "2024-02-28T23:59:59Z",
- "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
], - "start_date": "2024-02-28T00:00:00Z",
- "time_resolution": "total"
}{- "spc_10987654321": {
- "avg": 0.5,
- "max": 1
}, - "spc_12345678901": {
- "avg": 0.5,
- "max": 1
}
}Returns the most current occupancy for a set of spaces or for all spaces in a portfolio. Only entry spaces are supported.
success
unable to authorize the given bearer token
access to this api is not allowed
unexpected error
{- "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
]
}{- "spc_10987654321": {
- "count": 5,
- "space_health_status": "healthy"
}, - "spc_12345678901": {
- "count": 5,
- "space_health_status": "healthy"
}
}Returns the current occupied status for a set of spaces or for all spaces in a portfolio.
success
unable to authorize the given bearer token
access to this api is not allowed
unexpected error
{- "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
]
}{- "spc_10987654321": false,
- "spc_12345678901": true
}Returns the current occupied and space health status for a set of spaces or for all spaces in a portfolio.
success
unable to authorize the given bearer token
access to this api is not allowed
unexpected error
{- "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
]
}{- "spc_10987654321": {
- "presence": true,
- "space_health_status": "healthy"
}, - "spc_12345678901": {
- "presence": true,
- "space_health_status": "healthy"
}
}Determines short-term Presence for a set of spaces or for all spaces in an organization. Only OA spaces and floors are supported.
request body input
success
request data was missing or invalid
unable to authorize the given bearer token
access to this api is not allowed
resource not found
unexpected error
{- "minutes_lookback": 60,
- "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
]
}{- "data": [
- {
- "metrics": [
- {
- "presence": true,
- "timestamp": "2023-05-17T00:00:00Z"
}
], - "space_id": "spc_1234567890"
}
]
}Returns a WebSocket endpoint to receive presence messages for spaces on a floor. See https://developers.density.io/websockets for websocket payload details.
success
BadRequestError is an error returned when the request is malformed or invalid.
UnauthorizedError is an error returned when the request is unauthorized.
ForbiddenError is an error returned when the request is forbidden.
NotFoundError is an error returned when the requested resource is not found.
InternalServerError is an error returned when the server encounters an error.
{- "ws_url": "string"
}Returns a WebSocket endpoint to receive count updates for a space and its children with entry sensors. See https://developers.density.io/websockets for websocket payload details.
success
BadRequestError is an error returned when the request is malformed or invalid.
UnauthorizedError is an error returned when the request is unauthorized.
ForbiddenError is an error returned when the request is forbidden.
NotFoundError is an error returned when the requested resource is not found.
InternalServerError is an error returned when the server encounters an error.
{- "ws_url": "string"
}OAuth token flow for machine-to-machine users. Generate an access token using client credentials.
success
bad request
unable to authorize client
unexpected error
{- "client_id": "string",
- "client_secret": "string",
- "grant_type": "client_credentials"
}{- "access_token": "string",
- "expires_in": "string",
- "token_type": "string"
}success
BadRequestError is an error returned when the request is malformed or invalid.
UnauthorizedError is an error returned when the request is unauthorized.
ForbiddenError is an error returned when the request is forbidden.
NotFoundError is an error returned when the requested resource is not found.
InternalServerError is an error returned when the server encounters an error.
{- "serial_numbers": [
- "string"
], - "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
]
}[- {
- "created_at": "2019-08-24T14:15:22Z",
- "firmware_version": "string",
- "hardware_type": "ob1",
- "location": {
- "building_ids": [
- "spc_12345678901"
], - "floor_ids": [
- "spc_10987654321"
], - "space_ids": [
- "spc_50985556621"
]
}, - "network_addresses": [
- {
- "address": "string",
- "family": "string",
- "if": "string",
- "mac": "string"
}
], - "sensor_type": "oa",
- "serial_number": "A1B6Z10",
- "updated_at": "2019-08-24T14:15:22Z"
}
]Request body input. Can filter by either serial numbers or space ids.
success
{- "end_date": "2024-02-28T23:59:59Z",
- "serial_numbers": [
- "string"
], - "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
], - "start_date": "2024-02-28T00:00:00Z"
}{- "A1B6Z10": [
- {
- "health_status": "healthy",
- "timestamp": "2024-01-01T00:00:00Z"
}, - {
- "health_status": "healthy",
- "timestamp": "2024-01-01T00:00:00Z"
}
]
}success
BadRequestError is an error returned when the request is malformed or invalid.
UnauthorizedError is an error returned when the request is unauthorized.
ForbiddenError is an error returned when the request is forbidden.
NotFoundError is an error returned when the requested resource is not found.
InternalServerError is an error returned when the server encounters an error.
{- "serial_numbers": [
- "string"
], - "space_ids": [
- "spc_12345678901",
- "spc_10987654321"
]
}{- "data": [
- {
- "health_status": "healthy",
- "last_status_change": "2019-08-24T14:15:22Z",
- "serial_number": "string"
}
]
}Get all spaces for an organization.
success
unable to authorize the given bearer token
access to this api is not allowed
unexpected error
[- {
- "address": "string",
- "capacity": 0,
- "children": [
- { }
], - "children_ids": [
- "string"
], - "cost_per_sqft": 0,
- "counting_mode": "string",
- "daily_reset": "string",
- "function": null,
- "go_live_date_utc": "string",
- "id": "string",
- "iwms_id": "string",
- "labels": [
- {
- "group": {
- "id": "string",
- "labels": [
- { }
], - "name": "string"
}, - "id": "string",
- "name": "string",
- "spaces": [
- {
- "current_count": 0,
- "id": "string",
- "name": "string"
}
]
}
], - "name": "string",
- "size_area": 0,
- "space_type": "portfolio",
- "status": "string",
- "time_zone": "string"
}
]Read a list of users in your organization. Only available for Machine to Machine tokens with correct permissions.
success
bad request
unable to authorize client
forbidden
unexpected error
[- {
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "full_name": "string",
- "id": "string",
- "role": "owner",
- "spaces": [
- "string"
]
}
]Create a user. Only available for Machine to Machine tokens with correct permissions.
success
bad request
unable to authorize client
forbidden
unexpected error
{- "email": "string",
- "full_name": "string",
- "role": "owner",
- "spaces": [
- "string"
]
}{- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "full_name": "string",
- "id": "string",
- "role": "owner",
- "spaces": [
- "string"
]
}Delete user. Only available for Machine to Machine tokens with correct permissions.
success
bad request
unable to authorize client
forbidden
unexpected error
{- "code": 0,
- "message": "string"
}Read a user in your organization. Only available for Machine to Machine tokens with correct permissions.
success
bad request
unable to authorize client
forbidden
unexpected error
{- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "full_name": "string",
- "id": "string",
- "role": "owner",
- "spaces": [
- "string"
]
}Update user role, name, or spaces. Only available for Machine to Machine tokens with correct permissions.
success
bad request
unable to authorize client
forbidden
unexpected error
{- "full_name": "string",
- "role": "owner",
- "spaces": [
- "string"
]
}{- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "full_name": "string",
- "id": "string",
- "role": "owner",
- "spaces": [
- "string"
]
}