Skip to content
Bottle

How a business is getting on

GET
/console/businesses/{id}/health
curl --request GET \
  --url https://example.com/console/businesses/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/health \
  --cookie bottle.session_token=<bottle.session_token>

When its people last signed in, how many have in the last 30 days, how far setup has got level by level, and the last thing staff did to it. Nothing from inside the business: setup is counts of steps only.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

Health

Media typeapplication/json
object
lastSignInAt
required
string | null format: date-time
activeMembers
required
integer
lastConsoleActionAt
required
string | null format: date-time
setup
required
object
settled
required
integer
total
required
integer
> 0
complete
required
boolean
dismissed
required
boolean
levels
required
Array<object>
object
key
required
string
Allowed values: open sell fleet week automate customers
doneCount
required
integer
total
required
integer
> 0
done
required
boolean
pendingSupportRequests
required
integer
Example
{
  "setup": {
    "levels": [
      {
        "key": "open"
      }
    ]
  }
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not Bottle staff, no two-step sign-in, or a console role too low for this

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}