Skip to content
Bottle

The figures beside the console's menu

GET
/console/summary
curl --request GET \
  --url https://example.com/console/summary \
  --cookie bottle.session_token=<bottle.session_token>

How many businesses there are, on trial, with a trial ending within a week, needing attention and locked; requests to be let in waiting for an answer; support sessions open; and trust centre requests waiting, or null where the trust centre is not set up.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Summary

Media typeapplication/json
object
businesses
required
integer
trialing
required
integer
trialEndingSoon
required
integer
needsAttention
required
integer
locked
required
integer
pendingSupportRequests
required
integer
openSupportSessions
required
integer
unreviewedBreakGlass
required
integer
pendingTrustRequests
required
integer | null
Examplegenerated
{
  "businesses": 1,
  "trialing": 1,
  "trialEndingSoon": 1,
  "needsAttention": 1,
  "locked": 1,
  "pendingSupportRequests": 1,
  "openSupportSessions": 1,
  "unreviewedBreakGlass": 1,
  "pendingTrustRequests": 1
}

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"
}

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"
    }
  ]
}