Stats

Get website summary statistics

GET/api/websites/{websiteId}/stats

Returns pageviews, unique visitors, visits, bounces, and total time on site for the selected date range and comparison period.

Try it

Server

GET/api/websites/{websiteId}/stats

Authorization

TokenbearerAuth (http bearer)

x-umami-share-contextshareContext (apiKey)

x-umami-share-tokenshareToken (apiKey)

Credentials stay in this browser tab and are never sent anywhere except the API.

Path parameters

websiteIdrequired

Query parameters

startAtoptional

endAtoptional

startDateoptional

endDateoptional

timezoneoptional

unitoptional

compareoptional

periodoptional

pathoptional

referreroptional

titleoptional

queryoptional

osoptional

browseroptional

deviceoptional

countryoptional

regionoptional

cityoptional

tagoptional

hostnameoptional

distinctIdoptional

languageoptional

eventoptional

utmSourceoptional

utmMediumoptional

utmCampaignoptional

utmContentoptional

utmTermoptional

segmentoptional

cohortoptional

eventTypeoptional

excludeBounceoptional

matchoptional

Response

Send a request to see the response.

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	Website ID.

Query parameters

Name	Type	Description
startAt	number	Start of the date range as a Unix timestamp in milliseconds.
endAt	number	End of the date range as a Unix timestamp in milliseconds.
startDate	string	Start of the date range as an ISO 8601 date or date-time.
endDate	string	End of the date range as an ISO 8601 date or date-time.
timezone	string	IANA time zone used to interpret dates and group results, for example America/New_York.
unit	string	Time interval used to group results: minute, hour, day, month, or year.
compare	enum<string>	Comparison period: prev for the previous period or yoy for the same period last year. Options: `prev`, `yoy`
period	enum<string>	Relative date range, for example 7d or 30day, used instead of an explicit startAt/endAt range. Options: `today`, `24h`, `7d`, `30d`, `0day`, `24hour`, `0week`, `7day`, `0month`, `30day`, `90day`, `0year`, `6month`, `12month`
path	string	Filter by page URL path.
referrer	string	Filter by referring URL.
title	string	Filter by page title.
query	string	Filter by page URL query string.
os	string	Operating system used by the visitor.
browser	string	Browser used by the visitor.
device	string	Device category used by the visitor.
country	string	Country code of the visitor.
region	string	Region or subdivision of the visitor.
city	string	City of the visitor.
tag	string	Tag attached to the tracked activity.
hostname	string	Hostname on which the activity occurred.
distinctId	string	Custom identifier assigned to the visitor.
language	string	Preferred language reported by the visitor browser.
event	string	Filter by custom event name.
utmSource	string	UTM campaign source.
utmMedium	string	UTM campaign medium.
utmCampaign	string	UTM campaign name.
utmContent	string	UTM campaign content.
utmTerm	string	UTM campaign search term.
segment	string	ID of a saved segment used to filter results.
cohort	string	ID of a saved cohort used to filter visitors.
eventType	integer	Event type: 1 for a pageview or 2 for a custom event.
excludeBounce	string	Set a non-empty value to exclude visits with only one pageview.
match	enum<string>	Whether records must match all filters or any filter. Options: `all`, `any`

Responses

200Summary stats with comparison.

Name	Type	Description
bouncesrequired	number	Number of visits with only one pageview.
comparisonrequired	object

pageviewsrequired	number	Pageview counts for the selected period.
totaltimerequired	number	Total visit duration in seconds.
visitorsrequired	number	Unique visitor counts for the selected period.
visitsrequired	number	Visit counts for the selected period.

200 example

{
  "bounces": 0,
  "comparison": {
    "bounces": 0,
    "pageviews": 0,
    "totaltime": 0,
    "visitors": 0,
    "visits": 0
  },
  "pageviews": 0,
  "totaltime": 0,
  "visitors": 0,
  "visits": 0
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/stats' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousGet pageviews and sessions over time NextGet detailed website metrics