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.

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
application/json
{
  • "end_date": "string",
  • "space_ids": [
    ],
  • "start_date": "string",
  • "time_resolution": "total"
}
Response samples
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Presence

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

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
application/json
{
  • "space_ids": [
    ]
}
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.

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
application/json
{
  • "space_ids": [
    ]
}
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.

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
application/json
{
  • "end_date": "string",
  • "space_ids": [
    ],
  • "start_date": "string",
  • "time_resolution": "total"
}
Response samples
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Utilization

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

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
application/json
{
  • "end_date": "string",
  • "space_ids": [
    ],
  • "start_date": "string",
  • "time_resolution": "total"
}
Response samples
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Hello World

Validate your access to the Density public API.

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
Response samples
text/plain
Do… or do not. There is no try. - Yoda

Spaces

Gets spaces for an organization.

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
Response samples
application/json
[
  • {
    }
]

API Version

API version.

Responses
200

success

401

unable to authorize the given bearer token

403

access to this api is not allowed

get/version
Request samples
Response samples
text/plain
1.0.2