Umami website screenshot

Umami

Umami is an open source, privacy-first web analytics platform that provides website traffic insights without cookies or personal data collection, serving as a simple and fast alternative to Google Analytics. The Umami API provides full programmatic access to analytics data, website management, session tracking, event data, and team collaboration features for both self-hosted and cloud instances.

Umami publishes 7 APIs on the APIs.io network, including Authentication API, Events API, Sessions API, and 4 more. Tagged areas include Cookieless Tracking, Open Source, Privacy, Web Analytics, and Website Analytics.

The Umami catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Umami’s developer surface includes authentication, documentation, engineering blog, pricing, GitHub presence, signup flow, support, and 9 more developer resources.

🌐 Visit website 📡 Source on GitHub
46.1/100 developing ▬ flat Agent 37/100 agent ready Full breakdown ↓
scored 2026-08-05 · rubric v0.9.1
AccessFreemiumSelf serve⚡ Free to try
7 APIs 8 Features 6 Use Cases
Cookieless TrackingOpen SourcePrivacyWeb AnalyticsWebsite Analytics

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-05 · rubric v0.9.1
Composite quality — 46.1/100 · developing
Contract Quality 6.9 / 25
Developer Ergonomics 6.1 / 20
Commercial Clarity 12.6 / 20
Operational Transparency 4.8 / 13
Governance 8.3 / 12
Discoverability 7.4 / 10
Agent readiness — 37/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/umami: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 7

Individual APIs this provider publishes, each with its own machine-readable definition.

Umami Authentication API

Login and token verification

Umami Events API

Custom event tracking

Umami Sessions API

Visitor session data

Umami Teams API

Team and access management

Umami Users API

User account management

Umami Website Statistics API

Analytics metrics, pageviews, and statistics

Umami Websites API

Website management and configuration

Scroll for all 7

Postman Collections 7

Ready-to-run Postman collections for exercising this provider's APIs.

Umami Analytics Authentication API

POSTMAN

Umami Analytics Authentication Events API

POSTMAN

Umami Analytics Authentication Sessions API

POSTMAN

Umami Analytics Authentication Teams API

POSTMAN

Umami Analytics Authentication Users API

POSTMAN

Umami Analytics Authentication Website Statistics API

POSTMAN

Umami Analytics Authentication Websites API

POSTMAN

Scroll for all 7

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Umami Analytics API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Umami Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Umami Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Umami Finops

FINOPS

Features 8

Notable capabilities this provider offers.

Privacy-First Analytics

Tracks website traffic without cookies or personal data, fully GDPR compliant without consent banners.

Real-Time Data

Live visitor counts and real-time pageview tracking for immediate traffic insights.

Custom Events

Track custom user interactions and conversions with a simple JavaScript API.

Team Collaboration

Share analytics access across teams with role-based access control.

Self-Hosting Support

Deploy on your own infrastructure for complete data ownership and control.

Open Source

MIT-licensed open source software with active community development and full transparency.

Multi-Site Support

Manage and analyze multiple websites from a single Umami instance.

API Access

Full REST API for programmatic access to all analytics data and management functions.

Scroll for all 8

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Umami Context

0 classes · 0 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Umami API Rules

5 rules · 3 warnings 2 info

SPECTRAL

Umami API Rules

37 rules · 13 errors 15 warnings 9 info

SPECTRAL

JSON Schema 19

Standalone JSON Schema definitions for this provider's data models.

ActiveVisitors

1 properties

JSON SCHEMA

LoginRequest

2 properties

JSON SCHEMA

LoginResponse

2 properties

JSON SCHEMA

Metric

2 properties

JSON SCHEMA

OkResponse

1 properties

JSON SCHEMA

PageviewData

2 properties

JSON SCHEMA

SessionList

4 properties

JSON SCHEMA

Session

9 properties

JSON SCHEMA

SessionStats

5 properties

JSON SCHEMA

TeamList

4 properties

JSON SCHEMA

TeamMember

6 properties

JSON SCHEMA

TeamRequest

2 properties

JSON SCHEMA

Team

8 properties

JSON SCHEMA

UserRequest

3 properties

JSON SCHEMA

User

6 properties

JSON SCHEMA

WebsiteList

4 properties

JSON SCHEMA

WebsiteRequest

4 properties

JSON SCHEMA

Website

10 properties

JSON SCHEMA

WebsiteStats

5 properties

JSON SCHEMA

Scroll for all 19

JSON Structure 19

JSON Structure definitions describing this provider's data shapes.

Umami Active Visitors Structure

1 properties

JSON STRUCTURE

Umami Login Request Structure

2 properties

JSON STRUCTURE

Umami Login Response Structure

2 properties

JSON STRUCTURE

Umami Metric Structure

2 properties

JSON STRUCTURE

Umami Ok Response Structure

1 properties

JSON STRUCTURE

Umami Pageview Data Structure

2 properties

JSON STRUCTURE

Umami Session List Structure

4 properties

JSON STRUCTURE

Umami Session Stats Structure

5 properties

JSON STRUCTURE

Umami Session Structure

9 properties

JSON STRUCTURE

Umami Team List Structure

4 properties

JSON STRUCTURE

Umami Team Member Structure

6 properties

JSON STRUCTURE

Umami Team Request Structure

2 properties

JSON STRUCTURE

Umami Team Structure

8 properties

JSON STRUCTURE

Umami User Request Structure

3 properties

JSON STRUCTURE

Umami User Structure

6 properties

JSON STRUCTURE

Umami Website List Structure

4 properties

JSON STRUCTURE

Umami Website Request Structure

4 properties

JSON STRUCTURE

Umami Website Stats Structure

5 properties

JSON STRUCTURE

Umami Website Structure

10 properties

JSON STRUCTURE

Scroll for all 19

Examples 19

Example request and response payloads for these APIs.

Umami Active Visitors Example

1 fields

EXAMPLE

Umami Login Request Example

2 fields

EXAMPLE

Umami Login Response Example

2 fields

EXAMPLE

Umami Metric Example

2 fields

EXAMPLE

Umami Ok Response Example

1 fields

EXAMPLE

Umami Pageview Data Example

2 fields

EXAMPLE

Umami Session Example

9 fields

EXAMPLE

Umami Session List Example

4 fields

EXAMPLE

Umami Session Stats Example

5 fields

EXAMPLE

Umami Team Example

8 fields

EXAMPLE

Umami Team List Example

4 fields

EXAMPLE

Umami Team Member Example

6 fields

EXAMPLE

Umami Team Request Example

2 fields

EXAMPLE

Umami User Example

6 fields

EXAMPLE

Umami User Request Example

3 fields

EXAMPLE

Umami Website Example

10 fields

EXAMPLE

Umami Website List Example

4 fields

EXAMPLE

Umami Website Request Example

4 fields

EXAMPLE

Umami Website Stats Example

5 fields

EXAMPLE

Scroll for all 19

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Umami Authentication

http · 1 scheme

SECURITY

Umami Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Umami Agentic Access

23 operations · 10 acting

23 operations · 10 acting

AGENTIC

Use Cases 6

What developers build with this provider.

Website Performance Monitoring

Track pageviews, unique visitors, bounce rates, and session duration for website optimization.

Privacy-Compliant Analytics

Replace Google Analytics with a cookieless solution that requires no consent banners under GDPR.

Marketing Analytics

Analyze traffic sources, referrers, and UTM campaign data to measure marketing effectiveness.

Custom Event Tracking

Track button clicks, form submissions, and custom conversions using the Umami event API.

Developer Dashboards

Build custom analytics dashboards using the REST API to display site metrics in your own apps.

Multi-Tenant Analytics

Provide analytics access to multiple clients or teams with shared infrastructure and access controls.

Integrations 5

Pre-built integrations with other platforms and tools.

Next.js

First-class integration with Next.js via the @umami/nextjs package for page view tracking.

WordPress

Track WordPress sites by adding the Umami tracking script via plugin or manual installation.

Vercel

Deploy Umami on Vercel with a one-click deployment for managed self-hosting.

Docker

Run Umami in any environment using the official Docker container image.

Cloudflare

Deploy tracking scripts behind Cloudflare for performance and abuse prevention.

Solutions 2

Packaged solutions this provider offers.

Umami Cloud

Hosted Umami instance at cloud.umami.is with managed infrastructure and API key authentication.

Umami Self-Hosted

Run your own Umami instance on any infrastructure with full data ownership and JWT authentication.

Resources

Get Started 2

Portal, sign-up, and the first successful call

Login
Login
 Signup
Signup

Documentation 1

Reference material describing how the API behaves

Documentation
Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

SpectralRules
SpectralRules
 Vocabulary
Vocabulary

Build 2

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace
PostmanWorkspace
 GitHub
GitHub

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Operate 1

Status, limits, changes, and where to get help

Support
Support

Commercial 1

Pricing, plans, and the legal terms of use

Pricing
Pricing

Company 3

The organization behind the API

LinkedIn
LinkedIn
 Website
Website
 Blog
Blog

Other 1

Properties that don't map to a standard resource type

SelfHosting
SelfHosting

Source (apis.yml)

apis.yml Raw ↑ 
aid: umami
name: Umami
description: Umami is an open source, privacy-first web analytics platform that provides website traffic insights without
  cookies or personal data collection, serving as a simple and fast alternative to Google Analytics. The Umami API provides
  full programmatic access to analytics data, website management, session tracking, event data, and team collaboration features
  for both self-hosted and cloud instances.
type: Index
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/umami.png
tags:
- Cookieless Tracking
- Open Source
- Privacy
- Web Analytics
- Website Analytics
url: https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/apis.yml
created: '2026-03-26'
modified: '2026-05-19'
specificationVersion: '0.19'
apis:
- aid: umami:umami-authentication-api
  name: Umami Authentication API
  description: Login and token verification
  humanURL: https://umami.is
  baseURL: https://api.umami.is
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/umami-authentication-api-openapi.yml
  - type: Documentation
    url: https://umami.is/docs
  - type: GettingStarted
    url: https://umami.is/docs/getting-started
  - type: APIDocumentation
    url: https://umami.is/docs/api
  - type: GitHubOrg
    url: https://github.com/umami-software/umami
  - type: JSONSchema
    url: json-schema/umami-website-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-pageview-data-schema.json
  - type: JSONSchema
    url: json-schema/umami-metric-schema.json
  - type: JSONSchema
    url: json-schema/umami-active-visitors-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-member-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-response-schema.json
  - type: JSONSchema
    url: json-schema/umami-ok-response-schema.json
  - type: JSONStructure
    url: json-structure/umami-website-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-stats-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-metric-structure.json
  - type: JSONStructure
    url: json-structure/umami-user-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-member-structure.json
  - type: JSONLDContext
    url: json-ld/umami-context.jsonld
  - type: Examples
    url: examples/umami-website-example.json
  - type: Examples
    url: examples/umami-website-stats-example.json
  - type: Examples
    url: examples/umami-pageview-data-example.json
  - type: Examples
    url: examples/umami-metric-example.json
  - type: Examples
    url: examples/umami-session-example.json
  - type: Examples
    url: examples/umami-session-stats-example.json
  - type: Examples
    url: examples/umami-user-example.json
  - type: Examples
    url: examples/umami-team-example.json
  - type: Examples
    url: examples/umami-active-visitors-example.json
- aid: umami:umami-events-api
  name: Umami Events API
  description: Custom event tracking
  humanURL: https://umami.is
  baseURL: https://api.umami.is
  tags:
  - Events
  properties:
  - type: OpenAPI
    url: openapi/umami-events-api-openapi.yml
  - type: Documentation
    url: https://umami.is/docs
  - type: GettingStarted
    url: https://umami.is/docs/getting-started
  - type: APIDocumentation
    url: https://umami.is/docs/api
  - type: GitHubOrg
    url: https://github.com/umami-software/umami
  - type: JSONSchema
    url: json-schema/umami-website-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-pageview-data-schema.json
  - type: JSONSchema
    url: json-schema/umami-metric-schema.json
  - type: JSONSchema
    url: json-schema/umami-active-visitors-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-member-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-response-schema.json
  - type: JSONSchema
    url: json-schema/umami-ok-response-schema.json
  - type: JSONStructure
    url: json-structure/umami-website-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-stats-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-metric-structure.json
  - type: JSONStructure
    url: json-structure/umami-user-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-member-structure.json
  - type: JSONLDContext
    url: json-ld/umami-context.jsonld
  - type: Examples
    url: examples/umami-website-example.json
  - type: Examples
    url: examples/umami-website-stats-example.json
  - type: Examples
    url: examples/umami-pageview-data-example.json
  - type: Examples
    url: examples/umami-metric-example.json
  - type: Examples
    url: examples/umami-session-example.json
  - type: Examples
    url: examples/umami-session-stats-example.json
  - type: Examples
    url: examples/umami-user-example.json
  - type: Examples
    url: examples/umami-team-example.json
  - type: Examples
    url: examples/umami-active-visitors-example.json
- aid: umami:umami-sessions-api
  name: Umami Sessions API
  description: Visitor session data
  humanURL: https://umami.is
  baseURL: https://api.umami.is
  tags:
  - Sessions
  properties:
  - type: OpenAPI
    url: openapi/umami-sessions-api-openapi.yml
  - type: Documentation
    url: https://umami.is/docs
  - type: GettingStarted
    url: https://umami.is/docs/getting-started
  - type: APIDocumentation
    url: https://umami.is/docs/api
  - type: GitHubOrg
    url: https://github.com/umami-software/umami
  - type: JSONSchema
    url: json-schema/umami-website-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-pageview-data-schema.json
  - type: JSONSchema
    url: json-schema/umami-metric-schema.json
  - type: JSONSchema
    url: json-schema/umami-active-visitors-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-member-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-response-schema.json
  - type: JSONSchema
    url: json-schema/umami-ok-response-schema.json
  - type: JSONStructure
    url: json-structure/umami-website-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-stats-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-metric-structure.json
  - type: JSONStructure
    url: json-structure/umami-user-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-member-structure.json
  - type: JSONLDContext
    url: json-ld/umami-context.jsonld
  - type: Examples
    url: examples/umami-website-example.json
  - type: Examples
    url: examples/umami-website-stats-example.json
  - type: Examples
    url: examples/umami-pageview-data-example.json
  - type: Examples
    url: examples/umami-metric-example.json
  - type: Examples
    url: examples/umami-session-example.json
  - type: Examples
    url: examples/umami-session-stats-example.json
  - type: Examples
    url: examples/umami-user-example.json
  - type: Examples
    url: examples/umami-team-example.json
  - type: Examples
    url: examples/umami-active-visitors-example.json
- aid: umami:umami-teams-api
  name: Umami Teams API
  description: Team and access management
  humanURL: https://umami.is
  baseURL: https://api.umami.is
  tags:
  - Teams
  properties:
  - type: OpenAPI
    url: openapi/umami-teams-api-openapi.yml
  - type: Documentation
    url: https://umami.is/docs
  - type: GettingStarted
    url: https://umami.is/docs/getting-started
  - type: APIDocumentation
    url: https://umami.is/docs/api
  - type: GitHubOrg
    url: https://github.com/umami-software/umami
  - type: JSONSchema
    url: json-schema/umami-website-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-pageview-data-schema.json
  - type: JSONSchema
    url: json-schema/umami-metric-schema.json
  - type: JSONSchema
    url: json-schema/umami-active-visitors-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-member-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-response-schema.json
  - type: JSONSchema
    url: json-schema/umami-ok-response-schema.json
  - type: JSONStructure
    url: json-structure/umami-website-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-stats-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-metric-structure.json
  - type: JSONStructure
    url: json-structure/umami-user-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-member-structure.json
  - type: JSONLDContext
    url: json-ld/umami-context.jsonld
  - type: Examples
    url: examples/umami-website-example.json
  - type: Examples
    url: examples/umami-website-stats-example.json
  - type: Examples
    url: examples/umami-pageview-data-example.json
  - type: Examples
    url: examples/umami-metric-example.json
  - type: Examples
    url: examples/umami-session-example.json
  - type: Examples
    url: examples/umami-session-stats-example.json
  - type: Examples
    url: examples/umami-user-example.json
  - type: Examples
    url: examples/umami-team-example.json
  - type: Examples
    url: examples/umami-active-visitors-example.json
- aid: umami:umami-users-api
  name: Umami Users API
  description: User account management
  humanURL: https://umami.is
  baseURL: https://api.umami.is
  tags:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/umami-users-api-openapi.yml
  - type: Documentation
    url: https://umami.is/docs
  - type: GettingStarted
    url: https://umami.is/docs/getting-started
  - type: APIDocumentation
    url: https://umami.is/docs/api
  - type: GitHubOrg
    url: https://github.com/umami-software/umami
  - type: JSONSchema
    url: json-schema/umami-website-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-pageview-data-schema.json
  - type: JSONSchema
    url: json-schema/umami-metric-schema.json
  - type: JSONSchema
    url: json-schema/umami-active-visitors-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-member-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-response-schema.json
  - type: JSONSchema
    url: json-schema/umami-ok-response-schema.json
  - type: JSONStructure
    url: json-structure/umami-website-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-stats-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-metric-structure.json
  - type: JSONStructure
    url: json-structure/umami-user-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-member-structure.json
  - type: JSONLDContext
    url: json-ld/umami-context.jsonld
  - type: Examples
    url: examples/umami-website-example.json
  - type: Examples
    url: examples/umami-website-stats-example.json
  - type: Examples
    url: examples/umami-pageview-data-example.json
  - type: Examples
    url: examples/umami-metric-example.json
  - type: Examples
    url: examples/umami-session-example.json
  - type: Examples
    url: examples/umami-session-stats-example.json
  - type: Examples
    url: examples/umami-user-example.json
  - type: Examples
    url: examples/umami-team-example.json
  - type: Examples
    url: examples/umami-active-visitors-example.json
- aid: umami:umami-website-statistics-api
  name: Umami Website Statistics API
  description: Analytics metrics, pageviews, and statistics
  humanURL: https://umami.is
  baseURL: https://api.umami.is
  tags:
  - Website Statistics
  properties:
  - type: OpenAPI
    url: openapi/umami-website-statistics-api-openapi.yml
  - type: Documentation
    url: https://umami.is/docs
  - type: GettingStarted
    url: https://umami.is/docs/getting-started
  - type: APIDocumentation
    url: https://umami.is/docs/api
  - type: GitHubOrg
    url: https://github.com/umami-software/umami
  - type: JSONSchema
    url: json-schema/umami-website-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-pageview-data-schema.json
  - type: JSONSchema
    url: json-schema/umami-metric-schema.json
  - type: JSONSchema
    url: json-schema/umami-active-visitors-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-member-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-response-schema.json
  - type: JSONSchema
    url: json-schema/umami-ok-response-schema.json
  - type: JSONStructure
    url: json-structure/umami-website-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-stats-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-metric-structure.json
  - type: JSONStructure
    url: json-structure/umami-user-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-member-structure.json
  - type: JSONLDContext
    url: json-ld/umami-context.jsonld
  - type: Examples
    url: examples/umami-website-example.json
  - type: Examples
    url: examples/umami-website-stats-example.json
  - type: Examples
    url: examples/umami-pageview-data-example.json
  - type: Examples
    url: examples/umami-metric-example.json
  - type: Examples
    url: examples/umami-session-example.json
  - type: Examples
    url: examples/umami-session-stats-example.json
  - type: Examples
    url: examples/umami-user-example.json
  - type: Examples
    url: examples/umami-team-example.json
  - type: Examples
    url: examples/umami-active-visitors-example.json
- aid: umami:umami-websites-api
  name: Umami Websites API
  description: Website management and configuration
  humanURL: https://umami.is
  baseURL: https://api.umami.is
  tags:
  - Websites
  properties:
  - type: OpenAPI
    url: openapi/umami-websites-api-openapi.yml
  - type: Documentation
    url: https://umami.is/docs
  - type: GettingStarted
    url: https://umami.is/docs/getting-started
  - type: APIDocumentation
    url: https://umami.is/docs/api
  - type: GitHubOrg
    url: https://github.com/umami-software/umami
  - type: JSONSchema
    url: json-schema/umami-website-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-website-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-pageview-data-schema.json
  - type: JSONSchema
    url: json-schema/umami-metric-schema.json
  - type: JSONSchema
    url: json-schema/umami-active-visitors-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-session-stats-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-schema.json
  - type: JSONSchema
    url: json-schema/umami-user-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-list-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-member-schema.json
  - type: JSONSchema
    url: json-schema/umami-team-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-request-schema.json
  - type: JSONSchema
    url: json-schema/umami-login-response-schema.json
  - type: JSONSchema
    url: json-schema/umami-ok-response-schema.json
  - type: JSONStructure
    url: json-structure/umami-website-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-website-stats-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-structure.json
  - type: JSONStructure
    url: json-structure/umami-session-list-structure.json
  - type: JSONStructure
    url: json-structure/umami-metric-structure.json
  - type: JSONStructure
    url: json-structure/umami-user-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-structure.json
  - type: JSONStructure
    url: json-structure/umami-team-member-structure.json
  - type: JSONLDContext
    url: json-ld/umami-context.jsonld
  - type: Examples
    url: examples/umami-website-example.json
  - type: Examples
    url: examples/umami-website-stats-example.json
  - type: Examples
    url: examples/umami-pageview-data-example.json
  - type: Examples
    url: examples/umami-metric-example.json
  - type: Examples
    url: examples/umami-session-example.json
  - type: Examples
    url: examples/umami-session-stats-example.json
  - type: Examples
    url: examples/umami-user-example.json
  - type: Examples
    url: examples/umami-team-example.json
  - type: Examples
    url: examples/umami-active-visitors-example.json
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/umami/overview
- type: AgenticAccess
  url: agentic-access/umami-agentic-access.yml
- type: DomainSecurity
  url: security/umami-domain-security.yml
- type: Authentication
  url: authentication/umami-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/umami-software
- type: Website
  url: https://umami.is
- type: Documentation
  url: https://umami.is/docs
- type: Blog
  url: https://umami.is/blog
- type: Pricing
  url: https://umami.is/pricing
- type: GitHub
  url: https://github.com/umami-software/umami
- type: Login
  url: https://cloud.umami.is
- type: Signup
  url: https://cloud.umami.is
- type: SelfHosting
  url: https://umami.is/docs/install
- type: Support
  url: https://umami.is/docs/support
- type: SpectralRules
  url: rules/umami-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/umami-vocabulary.yaml
- type: Features
  data:
  - name: Privacy-First Analytics
    description: Tracks website traffic without cookies or personal data, fully GDPR compliant without consent banners.
  - name: Real-Time Data
    description: Live visitor counts and real-time pageview tracking for immediate traffic insights.
  - name: Custom Events
    description: Track custom user interactions and conversions with a simple JavaScript API.
  - name: Team Collaboration
    description: Share analytics access across teams with role-based access control.
  - name: Self-Hosting Support
    description: Deploy on your own infrastructure for complete data ownership and control.
  - name: Open Source
    description: MIT-licensed open source software with active community development and full transparency.
  - name: Multi-Site Support
    description: Manage and analyze multiple websites from a single Umami instance.
  - name: API Access
    description: Full REST API for programmatic access to all analytics data and management functions.
- type: UseCases
  data:
  - name: Website Performance Monitoring
    description: Track pageviews, unique visitors, bounce rates, and session duration for website optimization.
  - name: Privacy-Compliant Analytics
    description: Replace Google Analytics with a cookieless solution that requires no consent banners under GDPR.
  - name: Marketing Analytics
    description: Analyze traffic sources, referrers, and UTM campaign data to measure marketing effectiveness.
  - name: Custom Event Tracking
    description: Track button clicks, form submissions, and custom conversions using the Umami event API.
  - name: Developer Dashboards
    description: Build custom analytics dashboards using the REST API to display site metrics in your own apps.
  - name: Multi-Tenant Analytics
    description: Provide analytics access to multiple clients or teams with shared infrastructure and access controls.
- type: Integrations
  data:
  - name: Next.js
    description: First-class integration with Next.js via the @umami/nextjs package for page view tracking.
  - name: WordPress
    description: Track WordPress sites by adding the Umami tracking script via plugin or manual installation.
  - name: Vercel
    description: Deploy Umami on Vercel with a one-click deployment for managed self-hosting.
  - name: Docker
    description: Run Umami in any environment using the official Docker container image.
  - name: Cloudflare
    description: Deploy tracking scripts behind Cloudflare for performance and abuse prevention.
- type: Solutions
  data:
  - name: Umami Cloud
    description: Hosted Umami instance at cloud.umami.is with managed infrastructure and API key authentication.
  - name: Umami Self-Hosted
    description: Run your own Umami instance on any infrastructure with full data ownership and JWT authentication.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com