Before you start
A Business plan or higher. The Stats API is a Business-plan feature, so a valid key on a cheaper plan is refused with a plan error rather than a key error. An API key also belongs to one team, so create it in the team that owns the site.
Set it up
- Open Plausible and switch to the team that owns the site.
- Settings → API keys → New API key.
- Name it
spridand create it. Plausible shows it once. - Copy the key and leave it on your clipboard.
- Your site id is the domain exactly as it was added to Plausible: no
https://, no trailing slash. It is the last part of the site’s URL,plausible.io/<site id>.
Connect to Sprid
sprid connect plausible --key-from-clipboard --site example.comSelf-hosting? Add --host https://analytics.example.com. Add --use to make Plausible the source Sprid reports website traffic from; Only one provider answers explains which provider answers when several are connected.
Typing the command yourself? Copy the key last, as Keys from your clipboard explains, with the fallback for a shell without a clipboard.
Check the connection
Run sprid status, then ask your agent: “Read this website’s visitors for the last 28 days through Sprid and say which provider answered.” A saved key confirms setup; only the live read confirms access.
If something goes wrong
- Business plan required: the key is fine; the plan does not include the Stats API. Move to Business, or use PostHog or Google Analytics for this app instead. Nothing needs re-entering afterwards.
- Unauthorized: the key belongs to a different team from the site. Create the key inside the team that owns the site.
- Site not found: the site id is the domain as Plausible has it, with no scheme and no trailing slash.
- Rate limited: Plausible allows 600 requests an hour per key. One reading is well inside that, so check whether another tool shares the key.
What Sprid can and cannot read here
Visitors, pageviews, visits, bounce rate and visit duration, plus breakdowns by country, region, city, source, channel, campaign, term, page, entry page, exit page, hostname, browser, operating system and device.
Plausible is cookieless: it has no person id, so a visitor is its own daily estimate rather than someone Sprid can follow between days. Window totals therefore come from Plausible directly and are never the daily numbers added up. Bounces and session time arrive as a rate and an average, and Sprid turns them back into counts, so they carry Plausible’s rounding. Days are the site’s own time zone, not UTC.
Sources and verification
Prefer your terminal? sprid docs plausible reads this same guide.