Skip to content
Vespy API

Monthly physical occupancy rate time-series

GET
/api/analytics/occupancy-rate
curl --request GET \
  --url https://api.getvespy.com/api/analytics/occupancy-rate \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
points
required
Array<object>
object
month
required
string
/^\d{4}-\d{2}$/
occupancyRate
required
number
occupiedUnits
required
integer
totalUnits
required
integer
summary
required
object
averageOccupancyRate
required
number
latestOccupiedUnits
required
integer
totalUnits
required
integer
Examplegenerated
{
  "points": [
    {
      "month": "example",
      "occupancyRate": 1,
      "occupiedUnits": 1,
      "totalUnits": 1
    }
  ],
  "summary": {
    "averageOccupancyRate": 1,
    "latestOccupiedUnits": 1,
    "totalUnits": 1
  }
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}