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.
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": "string",
- "space_ids": [
- "string"
], - "start_date": "string",
- "time_resolution": "total"
}
{- "property1": {
- "avg": 0,
- "max": 0,
- "min": 0
}, - "property2": {
- "avg": 0,
- "max": 0,
- "min": 0
}
}
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": [
- "string"
]
}
{- "property1": true,
- "property2": true
}
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": [
- "string"
]
}
{- "property1": true,
- "property2": true
}
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": "1234567890"
}
]
}
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": [
- "string"
]
}
{- "property1": true,
- "property2": true
}
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": "string",
- "space_ids": [
- "string"
], - "start_date": "string",
- "time_resolution": "total"
}
{- "property1": {
- "percentage": 0,
- "raw": 0
}, - "property2": {
- "percentage": 0,
- "raw": 0
}
}
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": "string",
- "space_ids": [
- "string"
], - "start_date": "string",
- "time_resolution": "total"
}
{- "property1": {
- "avg": 0,
- "max": 0
}, - "property2": {
- "avg": 0,
- "max": 0
}
}
Returns a WebSocket endpoint to receive presence messages for spaces on a floor.
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"
}
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",
- "doorways": [
- {
- "id": "string",
- "sensor_placement": 0
}
], - "function": null,
- "geometry": {
- "circle_centroid_x_meters": 0,
- "circle_centroid_y_meters": 0,
- "circle_radius_meters": 0,
- "id": "string",
- "latitude": 0,
- "longitude": 0,
- "polygon_verticies": [
- {
- "x_from_origin_meters": 0,
- "y_from_origin_meters": 0
}
], - "shape": "string"
}, - "go_live_date_utc": "string",
- "id": "string",
- "iwms_id": "string",
- "labels": [
- {
- "group": {
- "id": "string",
- "name": "string"
}, - "id": "string",
- "name": "string",
- "spaces": [
- {
- "current_count": 0,
- "id": "string",
- "name": "string"
}
]
}
], - "max_dwell_minutes": 0,
- "name": "string",
- "plan": {
- "floor": {
- "id": "string",
- "name": "string",
- "parent_id": "string",
- "status": "string"
}, - "id": "string",
- "image_url": "string"
}, - "size_area": 0,
- "space_type": "portfolio",
- "status": "string",
- "tags": [
- "string"
], - "target_capacity": 0,
- "time_segments": [
- {
- "days": [
- "string"
], - "end": "string",
- "id": "string",
- "label": "string",
- "start": "string"
}
], - "time_zone": "string",
- "working_hours": "string"
}
]