Skip to content
Bottle

The website analytics at a glance

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

What the console’s analytics page shows before anybody opens Umami: for each set of figures, whether it can be opened here, and the last seven days in counts (visitors, visits, page views, bounces, time) with the five most visited paths and referring sites. Nothing about any one visitor; the office app’s paths come with ids already taken out. Read from Umami with Bottle’s own login, so only where Umami sign-in is set up (signIn: umami); otherwise every site says signInOff and opening lands on the share page. Kept for five minutes. Answers 404 where the analytics are not set up.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Each set of figures, and how opening them lands

Media typeapplication/json
object
signIn
required
string
Allowed values: umami share
from
required
string format: date-time
to
required
string format: date-time
sites
required
Array<object>
object
target
required
string
Allowed values: site app
available
required
boolean
state
required
string
Allowed values: ready signInOff failed off
figures
required
object
visitors
required
integer
visits
required
integer
pageviews
required
integer
bounces
required
integer
totalSeconds
required
integer
topPages
required
Array<object>
<= 5 items
object
path
required
string
views
required
integer
topReferrers
required
Array<object>
<= 5 items
object
referrer
required
string
visits
required
integer
Example
{
  "signIn": "umami",
  "sites": [
    {
      "target": "site",
      "state": "ready"
    }
  ]
}

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