Skip to content

All integrations

Connect Umami to ShipVitals

Page views, visitors, visits and bounces per website, self-hosted or Umami Cloud

AvailableAddress and key · about 3 minutes

Connect Umami

What it reads

View-only user (self-hosted)
Reads website stats; can't change anything
API key (Umami Cloud)
Reads website stats; Umami Cloud has no read-only key

Not read-only at Umami. A self-hosted View only user can't change anything. An Umami Cloud API key can do what your account can, as Umami Cloud has no read-only key; ShipVitals only reads website stats.

What ShipVitals keeps: The address, and the view-only user's password or the Umami Cloud API key, encrypted.

Every connector's scopes, on one page

How to connect

  1. Umami Cloud: enter https://cloud.umami.is, then create an API key in Settings → API keys and paste it, with no user name.
  2. Self-hosted: use the address you open Umami at, such as https://stats.example.com.
  3. In Settings → Users, add a user named shipvitals with the View only role.
  4. Enter that user's name and password below.

About 3 minutes.

Open Umami

How to revoke

Revoke it at Umami

Removing the connection in ShipVitals deletes the stored key at once.

What it powers

Dashboard tabs: Usage.

Figures it fills

  • Page views
  • Visitors
  • Visits
  • Bounces

Sync

  • Free: Daily
  • Indie: Hourly
  • Studio: Every 15 minutes
  • Agency: Every 15 minutes

Troubleshooting

Each error a connection can hit, and its fix. The connection's health page names the one it hit.

Access refused
Umami no longer accepts what ShipVitals signs in with. Create a new key, or connect again, and replace it in the connection.
A permission is missing
What ShipVitals has can't read everything it needs. Add the permissions under What it reads, or create a new key with them, and test again.
Access removed
ShipVitals' access was removed in Umami. Connect it again; the history it brought in is kept.
Rate-limited
Umami asked ShipVitals to slow down. Nothing to do: the sync carries on by itself and catches up.
Quota reached
The account used up a Umami quota. The sync resumes when the quota resets.
Not found
Something the connection reads is gone from Umami: renamed, moved or removed. Review the connection's resources, or connect again.
Umami is unavailable
Umami is having trouble on its side. Check its status page; ShipVitals retries by itself.
Couldn't reach Umami
ShipVitals can't reach Umami. If you host it yourself, it needs to be reachable from the internet: check the address, including any base path.
An answer ShipVitals didn't expect
Umami answered in a shape ShipVitals didn't expect, usually after a change on its side. We're told, and the data you have is kept.
A setting doesn't work
A field in the connection doesn't work with Umami. Check it against How to connect, and test again.

Docs