Retention

Get website retention

GET/api/websites/{websiteId}/retention

Returns daily retention for the website: for each first-visit date, how many visitors returned on later days and the percentage.

Try it

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	ID of the website.

Query parameters

Name	Type	Description
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`
startAtrequired	integer	Start of the date range as a Unix timestamp in milliseconds.
endAtrequired	integer	End of the date range as a Unix timestamp in milliseconds.
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.

Responses

200The operation completed successfully.

Name	Type	Description
daterequired	string
dayrequired	number
percentagerequired	number
returnVisitorsrequired	number
visitorsrequired	number	Unique visitor counts for the selected period.

200 example

[
  {
    "date": "string",
    "day": 0,
    "percentage": 0,
    "returnVisitors": 0,
    "visitors": 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
  }
}

404Not found.

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

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/retention?startAt=0&endAt=0' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousUpdate a tracking pixel NextGet real-time website activity