Density Public API (v3-beta)

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.

v3

Occupancy

Calculates the occupancy for a set of spaces or for all spaces in a portfolio.

Securityauth_token

Request

Request Body schema: application/json

request body input

end_date required	string end of the query date range
space_ids	Array of strings specific spaces to query
start_date required	string start of the query date range
time_resolution	string Default: "total" time resolution for the query results Enum: "total" "hour" "day" "week" "month" "year" "weekday" "hour_of_day"

Responses

200

success

400

request data was missing or invalid

401

unable to authorize the given bearer token

403

access to this api is not allowed

404

resource not found

500

unexpected error

post/v3/analytics/occupancy

Request samples

Payload
curl
Go
Python

application/json

{"end_date": "string",
"space_ids": ["string"
],
"start_date": "string",
"time_resolution": "total"
}

Response samples

application/json

{"property1": {"avg": 0,
"max": 0,
"min": 0
},
"property2": {"avg": 0,
"max": 0,
"min": 0
}
}

Presence

Returns the current occupied status for a set of spaces or for all spaces in a portfolio.

Securityauth_token

Request

Request Body schema: application/json

request body input

space_ids

Array of strings

Responses

200

success

401

unable to authorize the given bearer token

403

access to this api is not allowed

500

unexpected error

post/v3/analytics/presence

Request samples

Payload
curl
Go
Python

application/json

{"space_ids": ["string"
]
}

Response samples

application/json

{"property1": true,
"property2": true
}

StatusDeprecated

Returns the current occupied status for a set of spaces or for all spaces in a portfolio.

Securityauth_token

Request

Request Body schema: application/json

request body input

space_ids

Array of strings

Responses

200

success

401

unable to authorize the given bearer token

403

access to this api is not allowed

500

unexpected error

post/v3/analytics/status

Request samples

Payload
curl
Go
Python

application/json

{"space_ids": ["string"
]
}

Response samples

application/json

{"property1": true,
"property2": true
}

Time Used

Calculates the time used for a set of spaces or for all spaces in a portfolio.

Securityauth_token

Request

Request Body schema: application/json

request body input

end_date required	string end of the query date range
space_ids	Array of strings specific spaces to query
start_date required	string start of the query date range
time_resolution	string Default: "total" time resolution for the query results Enum: "total" "hour" "day" "week" "month" "year" "weekday" "hour_of_day"

Responses

200

success

400

request data was missing or invalid

401

unable to authorize the given bearer token

403

access to this api is not allowed

404

resource not found

500

unexpected error

post/v3/analytics/time-used

Request samples

Payload
curl
Go
Python

application/json

{"end_date": "string",
"space_ids": ["string"
],
"start_date": "string",
"time_resolution": "total"
}

Response samples

application/json

{"property1": {"percentage": 0,
"raw": 0
},
"property2": {"percentage": 0,
"raw": 0
}
}

Utilization

Calculates the utilization for a set of spaces or for all spaces in a portfolio.

Securityauth_token

Request

Request Body schema: application/json

request body input

end_date required	string end of the query date range
space_ids	Array of strings specific spaces to query
start_date required	string start of the query date range
time_resolution	string Default: "total" time resolution for the query results Enum: "total" "hour" "day" "week" "month" "year" "weekday" "hour_of_day"

Responses

200

success

400

request data was missing or invalid

401

unable to authorize the given bearer token

403

access to this api is not allowed

404

resource not found

500

unexpected error

post/v3/analytics/utilization

Request samples

Payload
curl
Go
Python

application/json

{"end_date": "string",
"space_ids": ["string"
],
"start_date": "string",
"time_resolution": "total"
}

Response samples

application/json

{"property1": {"avg": 0,
"max": 0
},
"property2": {"avg": 0,
"max": 0
}
}

Hello World

Validate your access to the Density public API.

Securityauth_token

Responses

200

success

401

unable to authorize the given bearer token

403

access to this api is not allowed

get/v3/hello-world

Request samples

curl
Go
Python

Response samples

text/plain

Do… or do not. There is no try. - Yoda

Spaces

Gets spaces for an organization.

Securityauth_token

Responses

200

success

401

unable to authorize the given bearer token

403

access to this api is not allowed

500

unexpected error

get/v3/spaces

Request samples

curl
Go
Python

Response samples

application/json

[{"address": "string",
"capacity": 0,
"children": [{ }
],
"children_ids": ["string"
],
"cost_per_sqft": 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"
}
]
}
],
"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"
],
"time_segments": [{"days": ["string"
],
"end": "string",
"id": "string",
"label": "string",
"start": "string"
}
],
"time_zone": "string",
"working_hours": "string"
}
]

API Version

API version.

Securityauth_token

Responses

200

success

401

unable to authorize the given bearer token

403

access to this api is not allowed

get/version

Request samples

curl
Go
Python

Response samples

text/plain

1.0.2