Umami

Umami integration (Data, Marketing). Imported from open-connector.

API key8 toolshttps://api.umami.is

GET

umami_get_current_user

Get the current Umami user for the configured API token.

/api/me

GET

umami_list_websites

List Umami websites available to the configured API token.

/api/websites

3 parameters

Param	Type	Required	Description
query	string	optional	Search query filter for the endpoint.
page	integer	optional	One-based page number for paginated Umami endpoints.
pageSize	integer	optional	Number of items to return per page.

GET

umami_get_website

Get metadata for a single Umami website.

/api/websites/{websiteId}

1 parameter

Param	Type	Required	Description
websiteId	string	required	The Umami website ID.

GET

umami_get_website_stats

Get aggregate pageview, visitor, visit, bounce, and time statistics for a website.

/api/websites/{websiteId}/stats

14 parameters

Param	Type	Required	Description
websiteId	string	required	The Umami website ID.
startAt	integer	required	Start timestamp in milliseconds since the Unix epoch.
endAt	integer	required	End timestamp in milliseconds since the Unix epoch.
timezone	string	required	IANA timezone name used by Umami for date grouping.
url	string	optional	URL path filter for the query.
referrer	string	optional	Referrer filter for the query.
title	string	optional	Page title filter for the query.
host	string	optional	Host filter for the query.
os	string	optional	Operating system filter for the query.
browser	string	optional	Browser filter for the query.
device	string	optional	Device filter for the query.
country	string	optional	Country filter for the query.
region	string	optional	Region filter for the query.
city	string	optional	City filter for the query.

GET

umami_get_pageviews

Get Umami pageview and session timeseries for a website.

/api/websites/{websiteId}/pageviews

15 parameters

Param	Type	Required	Description
websiteId	string	required	The Umami website ID.
startAt	integer	required	Start timestamp in milliseconds since the Unix epoch.
endAt	integer	required	End timestamp in milliseconds since the Unix epoch.
timezone	string	required	IANA timezone name used by Umami for date grouping.
url	string	optional	URL path filter for the query.
referrer	string	optional	Referrer filter for the query.
title	string	optional	Page title filter for the query.
host	string	optional	Host filter for the query.
os	string	optional	Operating system filter for the query.
browser	string	optional	Browser filter for the query.
device	string	optional	Device filter for the query.
country	string	optional	Country filter for the query.
region	string	optional	Region filter for the query.
city	string	optional	City filter for the query.
unit	string	optional	Time unit used for timeseries grouping.

GET

umami_get_metrics

Get grouped Umami website metrics such as URLs, referrers, browsers, or countries.

/api/websites/{websiteId}/metrics

16 parameters

Param	Type	Required	Description
websiteId	string	required	The Umami website ID.
startAt	integer	required	Start timestamp in milliseconds since the Unix epoch.
endAt	integer	required	End timestamp in milliseconds since the Unix epoch.
timezone	string	required	IANA timezone name used by Umami for date grouping.
url	string	optional	URL path filter for the query.
referrer	string	optional	Referrer filter for the query.
title	string	optional	Page title filter for the query.
host	string	optional	Host filter for the query.
os	string	optional	Operating system filter for the query.
browser	string	optional	Browser filter for the query.
device	string	optional	Device filter for the query.
country	string	optional	Country filter for the query.
region	string	optional	Region filter for the query.
city	string	optional	City filter for the query.
type	string	required	Website metric dimension to return.
limit	integer	optional	Maximum number of metric rows to return.

GET

umami_get_realtime

Get realtime active visitor data for an Umami website.

/api/realtime/{websiteId}

1 parameter

Param	Type	Required	Description
websiteId	string	required	The Umami website ID.

GET

umami_list_events

List tracked Umami events for a website within a time range.

/api/websites/{websiteId}/events

17 parameters

Param	Type	Required	Description
websiteId	string	required	The Umami website ID.
startAt	integer	required	Start timestamp in milliseconds since the Unix epoch.
endAt	integer	required	End timestamp in milliseconds since the Unix epoch.
timezone	string	required	IANA timezone name used by Umami for date grouping.
url	string	optional	URL path filter for the query.
referrer	string	optional	Referrer filter for the query.
title	string	optional	Page title filter for the query.
host	string	optional	Host filter for the query.
os	string	optional	Operating system filter for the query.
browser	string	optional	Browser filter for the query.
device	string	optional	Device filter for the query.
country	string	optional	Country filter for the query.
region	string	optional	Region filter for the query.
city	string	optional	City filter for the query.
query	string	optional	Search query filter for the endpoint.
page	integer	optional	One-based page number for paginated Umami endpoints.
pageSize	integer	optional	Number of items to return per page.