EvumiDocumentationDashboard

Get started

Your first request

Read today's analytics with a team-scoped API key.

Choose your team and create a key

Open Account settings → API keys. Choose Stats for read-only reporting. Restrict the key to the sites your application needs and set an expiry. Copy it when it is created; it is not returned again.

Keep the key on your server

Store it as EVUMI_API_KEY in your backend's secret configuration. Set EVUMI_URL to your deployment's HTTPS origin. Never embed this key in the public tracker, frontend code, or a query URL.

Query a site by domain

curl --request POST "$EVUMI_URL/api/v2/query" \
  --header "Authorization: Bearer $EVUMI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"site_id":"example.com","metrics":["visitors","visits","pageviews"],"date_range":"day"}'

site_id is the tracked domain, not a database UUID or team ID. day means today so far in the site's timezone.

Read the ordered result

For each row, dimensions and metrics follow the order in the request. For example, [12, 15, 28] above means 12 visitors, 15 visits, and 28 pageviews. This is an illustrative result, not live data. Read meta for coverage warnings. Missing values are null, not zero.

Use /api/v1/sites to list sites allowed by your key. All examples use the API key owner's current membership and site permissions.