API changelog

This page documents changes made to api.umami.is.

2024-09-09

Websites

• GET /websites/[id]/pageviews: Fixed region parameter to optional.
• GET /websites/[id]/events: Changed result set to website event details within a given time range.
• GET /websites/[id]/events/series: New event metrics endpoint (previously GET /websites/[id]/events).

Event Data

• GET /event-data/events : Moved to /websites/[id]/event-data/events.
• GET /event-data/fields : Moved to /websites/[id]/event-data/fields.
• GET /event-data/stats : Moved to /websites/[id]/event-data/stats.
• GET /websites/[id]/event-data/values : Added

Sessions

• GET /websites/:websiteId/sessions : Added
• GET /websites/:websiteId/sessions/stats : Added
• GET /websites/:websiteId/sessions/:sessionId : Added
• GET /websites/:websiteId/sessions/:sessionId/activity : Added
• GET /websites/:websiteId/sessions/:sessionId/properties : Added
• GET /websites/:websiteId/session-data/properties : Added
• GET /websites/:websiteId/session-data/values : Added

2024-05-23

Websites

• GET /websites/[id]/stats: Renamed change to prev.

2024-03-27

Websites

• GET /websites/[id]/stats: Renamed uniques to visitors. Added visits.

2024-02-16

Websites

• POST /websites: Added teamId as an optional parameter.

Teams

• /teams/[id]/websites/[websiteId]: Deprecated
• GET /teams/[id]/users/[userId]/index: Added

Reports

• GET /reports/index: Added websiteId and teamId added as query parameters.