Skip to content
Bottle

Open the website analytics

POST
/console/analytics-sso/start
curl --request POST \
  --url https://example.com/console/analytics-sso/start \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "target": "site", "view": "overview" }'

Makes a code good for one use in the next minute and answers with the address that spends it on the analytics host. The browser goes there next and is signed in to the analytics for eight hours, for as long as the person stays staff, landing on the chosen figures: site (getbottle.app, the default) or app (my.getbottle.app). Where Umami sign-in is set up, that is Umami itself as the person’s own view-only login, on the chosen view (the overview unless told otherwise); otherwise the read-only share page, and view is ignored. Recorded in the console log. Answers 404 where the analytics, or the chosen figures, are not set up.

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
target
string
default: site
Allowed values: site app
view
string
default: overview
Allowed values: overview realtime sessions events replays heatmaps utm funnels journeys

Responses

Section titled “Responses”

200

Section titled “200”

Where to send the browser

Media typeapplication/json
object
url
required
string format: uri
Examplegenerated
{
  "url": "https://example.com"
}

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, or no two-step sign-in

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

404

Section titled “404”

The analytics, or the chosen figures, are not set up on this deployment

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

422

Section titled “422”

Figures it does not know

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

429

Section titled “429”

Too many in the last minute

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