Move-outs per month (realized turnover)

GET

/api/analytics/move-outs

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

points

required

Array<object>

object

month

required

string

/^\d{4}-\d{2}$/

moveOuts

required

integer

summary

required

object

averagePerMonth

required

number

totalMoveOuts

required

integer

turnoverRate

required

number

Example^generated

{
  "points": [
    {
      "month": "example",
      "moveOuts": 1
    }
  ],
  "summary": {
    "averagePerMonth": 1,
    "totalMoveOuts": 1,
    "turnoverRate": 1
  }
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}