Umami

Umami Websites API

Website management and configuration

GitHub OpenAPI

Operations 94

GET /api/websites List websites #
POST /api/websites Create a website #
DELETE /api/websites/{websiteId} Delete a website #
GET /api/websites/{websiteId} Get a website #
POST /api/websites/{websiteId} Update a website #
GET /api/websites/{websiteId}/active Get active website visitors #
GET /api/websites/{websiteId}/annotations List website annotations #
POST /api/websites/{websiteId}/annotations Create a website annotation #
DELETE /api/websites/{websiteId}/annotations/{annotationId} Delete a website annotation #
GET /api/websites/{websiteId}/annotations/{annotationId} Get a website annotation #
POST /api/websites/{websiteId}/annotations/{annotationId} Update a website annotation #
GET /api/websites/{websiteId}/attribution Get website attribution #
GET /api/websites/{websiteId}/breakdown Get website breakdown #
GET /api/websites/{websiteId}/daterange Get the website's available date range #
GET /api/websites/{websiteId}/event-data List events with custom properties #
GET /api/websites/{websiteId}/event-data-pivot List event properties in table form #
GET /api/websites/{websiteId}/event-data-pivot/array-series Get event array values over time #
GET /api/websites/{websiteId}/event-data-pivot/date-series Get the distribution of event date values #
GET /api/websites/{websiteId}/event-data-pivot/numeric-series Get numeric event properties over time #
GET /api/websites/{websiteId}/event-data-pivot/numeric-stats Get numeric event property statistics #
GET /api/websites/{websiteId}/event-data-pivot/property-series Get event property values over time #
GET /api/websites/{websiteId}/event-data/{eventId} Get an event's custom properties #
GET /api/websites/{websiteId}/event-data/events Summarize properties by event #
GET /api/websites/{websiteId}/event-data/fields List event property fields #
GET /api/websites/{websiteId}/event-data/properties List event property usage #
GET /api/websites/{websiteId}/event-data/stats Get event property totals #
GET /api/websites/{websiteId}/event-data/values List event property values #
GET /api/websites/{websiteId}/events List tracked events #
GET /api/websites/{websiteId}/events/series Get custom event counts over time #
GET /api/websites/{websiteId}/events/stats Get website event statistics #
GET /api/websites/{websiteId}/export Export website analytics #
GET /api/websites/{websiteId}/funnels Get website funnels #
POST /api/websites/{websiteId}/funnels Create a website funnel #
DELETE /api/websites/{websiteId}/funnels/{funnelId} Delete a website funnel #
GET /api/websites/{websiteId}/funnels/{funnelId} Get a website funnel #
POST /api/websites/{websiteId}/funnels/{funnelId} Update a website funnel #
GET /api/websites/{websiteId}/funnels/{funnelId}/stats Get website saved funnel stats #
GET /api/websites/{websiteId}/funnels/stats Get website funnel stats #
GET /api/websites/{websiteId}/goals Get website goals #
POST /api/websites/{websiteId}/goals Create a website goal #
DELETE /api/websites/{websiteId}/goals/{goalId} Delete a website goal #
GET /api/websites/{websiteId}/goals/{goalId} Get a website goal #
POST /api/websites/{websiteId}/goals/{goalId} Update a website goal #
GET /api/websites/{websiteId}/goals/{goalId}/stats Get website saved goal stats #
GET /api/websites/{websiteId}/goals/stats Get website goal stats #
GET /api/websites/{websiteId}/heatmaps Get website heatmaps #
GET /api/websites/{websiteId}/journeys Get website journeys #
GET /api/websites/{websiteId}/metrics Get ranked website metrics #
GET /api/websites/{websiteId}/metrics/expanded Get detailed website metrics #
GET /api/websites/{websiteId}/pageviews Get pageviews and sessions over time #
GET /api/websites/{websiteId}/performance/chart Get website performance chart #
GET /api/websites/{websiteId}/performance/metrics Get website performance metrics #
GET /api/websites/{websiteId}/performance/stats Get website performance stats #
GET /api/websites/{websiteId}/recorder Get website recording settings #
GET /api/websites/{websiteId}/replays List website session replays #
GET /api/websites/{websiteId}/replays/{replayId} Get a session replay recording #
GET /api/websites/{websiteId}/replays/saved List saved session replays #
GET /api/websites/{websiteId}/replays/saved/{replayId} Check whether a replay is saved #
POST /api/websites/{websiteId}/replays/saved/{replayId} Save or unsave a session replay #
POST /api/websites/{websiteId}/reset Reset website analytics #
GET /api/websites/{websiteId}/retention Get website retention #
GET /api/websites/{websiteId}/revenue/chart Get website revenue over time #
GET /api/websites/{websiteId}/revenue/metrics Get website revenue by dimension #
GET /api/websites/{websiteId}/revenue/sessions List sessions with revenue #
GET /api/websites/{websiteId}/revenue/stats Get website revenue totals #
GET /api/websites/{websiteId}/segments List website segments and cohorts #
POST /api/websites/{websiteId}/segments Create a website segment or cohort #
DELETE /api/websites/{websiteId}/segments/{segmentId} Delete a website segment or cohort #
GET /api/websites/{websiteId}/segments/{segmentId} Get a website segment or cohort #
POST /api/websites/{websiteId}/segments/{segmentId} Update a website segment or cohort #
GET /api/websites/{websiteId}/session-data-pivot List session properties in table form #
GET /api/websites/{websiteId}/session-data/array-series Get session array values over time #
GET /api/websites/{websiteId}/session-data/date-series Get the distribution of session date values #
GET /api/websites/{websiteId}/session-data/numeric-series Get numeric session properties over time #
GET /api/websites/{websiteId}/session-data/numeric-stats Get numeric session property statistics #
GET /api/websites/{websiteId}/session-data/properties List session property usage #
GET /api/websites/{websiteId}/session-data/property-series Get session property values over time #
GET /api/websites/{websiteId}/session-data/stats Get activity by session property #
GET /api/websites/{websiteId}/session-data/values List session property values #
GET /api/websites/{websiteId}/sessions List visitor sessions #
DELETE /api/websites/{websiteId}/sessions/{sessionId} Delete a visitor session #
GET /api/websites/{websiteId}/sessions/{sessionId} Get a visitor session #
GET /api/websites/{websiteId}/sessions/{sessionId}/activity Get a visitor's session activity #
GET /api/websites/{websiteId}/sessions/{sessionId}/properties Get a session's custom properties #
GET /api/websites/{websiteId}/sessions/{sessionId}/replays List a visitor's session replays #
GET /api/websites/{websiteId}/sessions/stats Get visitor session statistics #
GET /api/websites/{websiteId}/sessions/weekly Get traffic by weekday and hour #
GET /api/websites/{websiteId}/shares List shares for a website #
POST /api/websites/{websiteId}/shares Create a share for a website #
GET /api/websites/{websiteId}/stats Get website summary statistics #
POST /api/websites/{websiteId}/transfer Transfer website ownership #
GET /api/websites/{websiteId}/utm/metrics Get website UTM metrics #
GET /api/websites/{websiteId}/values List website filter values #
GET /api/websites/charts Get visitor charts for websites #

Documentation

📖
Documentation
https://docs.umami.is
📖
GettingStarted
https://docs.umami.is/docs/collect-data

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/openapi/umami-websites-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-website-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-website-list-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-website-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-website-stats-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-pageview-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-metric-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-active-visitors-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-session-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-session-list-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-session-stats-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-user-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-team-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-team-list-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-team-member-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-team-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-login-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-login-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-ok-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-website-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-website-list-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-website-stats-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-session-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-session-list-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-metric-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-user-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-team-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-structure/umami-team-member-structure.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/overlays/umami-websites-api-overlay.yaml
🔗
Postman
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/postman/umami-websites-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/collections/umami-websites-api.opencollection.json
🔗
APIDocumentation
https://docs.umami.is/docs/api
🔗
GitHubOrg
https://github.com/umami-software/umami
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-ld/umami-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-website-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-website-stats-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-pageview-data-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-metric-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-session-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-session-stats-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-user-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-team-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/examples/umami-active-visitors-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/umami:umami-websites-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

umami-websites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Umami Websites API
  version: 3.3.1
  license:
    identifier: MIT
    name: MIT
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Websites across 2 of this provider''s published API definitions: umami-openapi.json, umami-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{instance}
  description: Self-hosted Umami instance (paths begin with /api). Umami Cloud serves the same API at https://api.umami.is/v1 per docs.umami.is/docs/api.
  variables:
    instance:
      default: your-umami-instance.example.com
tags:


# --- truncated at 32 KB (558 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/openapi/umami-websites-api-openapi.yml