API

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

2025-10-07

Filters

• Changed filter url to path.
• Changed filter host to hostname

Websites

• GET /websites/[id]/metrics: The type parameter url has been changed to path.
• GET /websites/[id]/stats: The reponse data structure has changed.

{
  "pageviews": 34210,
  "visitors": 9401,
  "visits": 12726,
  "bounces": 7918,
  "totaltime": 5214477,
  "comparison": {
    "pageviews": 30818,
    "visitors": 8776,
    "visits": 11756,
    "bounces": 7396,
    "totaltime": 1704355
  }
}

Events

• GET /event-data/values: The eventName query parameter has been changed to event.

Reports

• POST /reports: The insights report has been changed to breakdown.

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.