# umami

> Documentation for Umami, an open-source web and product analytics platform.

## Documentation

- [Introduction](/docs.md): An overview of Umami v3, the open-source web and product analytics platform, with its main features and how to get started on Cloud or self-hosted.
- [Installation](/docs/install.md): Install a self-hosted Umami instance from source, with Docker Compose, from a prebuilt Docker image, or on Kubernetes with a third-party Helm chart.
- [Getting updates](/docs/updates.md): Update a self-hosted Umami installation from source or with Docker, and refresh PostgreSQL statistics after a major upgrade.
- [FAQ](/docs/faq.md): Answers to common questions about Umami, including GDPR compliance, cookies, collected data, self-hosting, supported databases, and data retention.
- [Login](/docs/login.md): Log in to Umami with the default admin account, change the default password, and enable two-factor authentication for extra protection.
- [Add a website](/docs/add-a-website.md): Add a website to Umami by entering its name and domain, so you can start tracking its traffic in your dashboard.
- [Collect data](/docs/collect-data.md): Copy your website's tracking code from Umami, add it to your site's head section, and troubleshoot data that does not appear.
- [Enable Share URL](/docs/enable-share-url.md): Generate a public Share URL for a website in Umami and choose which traffic, behavior, and growth views are visible to others.
- [Environment variables](/docs/environment-variables.md): Reference for the runtime and build time environment variables you can set to configure a self-hosted Umami installation.
- [Enable Cloudflare headers](/docs/enable-cloudflare-headers.md): Configure Cloudflare and your reverse proxy to pass visitor location headers to Umami so it can record region and city data.
- [Use Google Tag Manager](/docs/google-tag-manager.md): Install the Umami tracker with a Google Tag Manager Custom HTML tag that creates the script element and keeps its data-website-id attribute.
- [Enable Redis](/docs/enable-redis.md): Enable Redis in self-hosted Umami with the REDIS_URL variable to cache lookups, reduce database load, and handle login sessions.
- [Two-factor authentication](/docs/two-factor-authentication.md): Set up two-factor authentication in Umami with an authenticator app, log in with backup codes, and require or reset 2FA as an admin.
- [Bypass ad blockers](/docs/bypass-ad-blockers.md): Keep ad blockers from blocking Umami by proxying the tracker and collection endpoint, self-hosting the script, or renaming them.
- [Exclude my own visits](/docs/exclude-my-own-visits.md): Stop your own visits from appearing in Umami stats by setting a localStorage flag in your browser for each website you track.
- [Tracker functions](/docs/tracker-functions.md): Use the umami.track() and umami.identify() tracker functions to send pageviews, events, event data, and session data from your own code.
- [Tracker configuration](/docs/tracker-configuration.md): Configure the Umami tracker script with data attributes for the host URL, auto-tracking, domains, tags, performance, privacy, and a before-send hook.
- [Track events](/docs/track-events.md): Track custom events in Umami with data attributes on HTML elements or with JavaScript, then view the events and their properties.
- [Distinct IDs](/docs/distinct-ids.md): Set a Distinct ID with umami.identify() or the Sending stats API to link a user's sessions and activity across visits and devices.
- [Tags](/docs/tags.md): Add the data-tag attribute to the Umami tracker script to group events under a tag for A/B testing, then filter your website data by tag.
- [Links](/docs/links.md): Create short tracking links in Umami that redirect to a destination URL and record clicks, with optional social preview and UTM parameters.
- [Pixels](/docs/pixels.md): Create Umami tracking pixels to record views in HTML emails and on external pages where JavaScript is not supported, and edit or delete them.
- [Event data](/docs/event-data.md): Attach custom properties to tracked events in Umami with data attributes or umami.track(), then view them on the Events page.
- [Annotations](/docs/annotations.md): Pin dated notes to a website's traffic chart in Umami to record deploys, campaigns, or outages, then drill into those dates.
- [Filters](/docs/filters.md): Filter Umami reports by URL, source, location, environment, UTM, and custom properties, and combine conditions with match modes and operators.
- [Segments](/docs/segments.md): Save commonly used filters as segments in Umami so you can quickly reapply them, and add, apply, edit, or delete segments.
- [Cohorts](/docs/cohorts.md): Create cohorts in Umami to group users who visited a URL or triggered an event within a date range, then apply them as filters.
- [Sessions](/docs/sessions.md): View visitor sessions in Umami, open individual visitor profiles, and explore and filter the custom session properties you have saved.
- [Replays](/docs/replays.md): Enable session replays in Umami, add the recorder script to your website, and watch and save recordings of real visitor sessions.
- [Heatmaps](/docs/heatmaps.md): Enable heatmaps in Umami to see where visitors click and how far they scroll on each page, grouped by screen width over a live page preview.
- [Performance](/docs/performance.md): Collect real-user Core Web Vitals with the Umami tracker and review LCP, INP, CLS, FCP, and TTFB by page, device, and browser.
- [Compare](/docs/compare.md): Use the Umami Compare insight to compare website stats and metrics against the previous period or the same period last year.
- [Breakdown](/docs/breakdown.md): Use the Umami Breakdown insight to segment visitors, visits, views, bounce rate, and visit duration by the fields and filters you choose.
- [Goals](/docs/goals.md): Create a goal in Umami to track the conversion rate of visitors who view a specific page or trigger a specific event within a date range.
- [Funnel](/docs/funnel.md): Create a funnel report in Umami to see how many visitors complete a sequence of page visits or events, and where they drop off between steps.
- [Journey](/docs/journey.md): Create a journey report in Umami to see the most common paths visitors take through your website, from where they start to where they drop off.
- [Retention](/docs/retention.md): Use the Umami Retention insight to see how many visitors return on the days after their first visit, shown as a daily cohort chart.
- [UTM](/docs/utm.md): Use the Umami UTM insight to see views broken down by the five standard UTM parameters and measure how your marketing campaigns perform.
- [Revenue](/docs/revenue.md): Track revenue in Umami by sending revenue and currency event data with tracker functions or data attributes, then run the Revenue insight.
- [Attribution](/docs/attribution.md): Use the Umami Attribution insight to see which referrers, paid ads, and UTM campaigns led to a page view or event, using first-click or last-click models.
- [Insights](/docs/insights.md): An overview of the insight reports built into Umami, including compare, breakdown, funnel, retention, UTM, goals, journey, revenue, and attribution.
- [Using boards](/docs/using-boards.md): Learn the Umami board types and how to view boards, customizable dashboards that combine widgets from websites, pixels, and links.
- [Add a board](/docs/add-a-board.md): Create, edit, clone, delete, and share boards in Umami to build custom dashboards for websites, pixels, and links.
- [Design a board](/docs/design-a-board.md): Use design mode in Umami to add rows and columns to a board, place traffic, event, and revenue components, and resize the layout.
- [Using teams](/docs/using-teams.md): Understand Umami team roles and permissions, and open a team from the Teams page or the quick team access dropdown in the sidebar.
- [Add a team](/docs/add-a-team.md): Create a team in Umami from the Settings page to organize users and share websites, with yourself added as the team owner.
- [Join a team](/docs/join-a-team.md): Share a team's access code with other users, regenerate the code, and join an existing Umami team by entering an access code.
- [Manage a team](/docs/manage-a-team.md): Add websites to a team, edit or remove team members as the team owner, and transfer websites between your account and a team you own.
- [Add a user](/docs/add-a-user.md): Create separate Umami user accounts from the Admin console, choose a role for each user, and require two-factor authentication.
- [Metric definitions](/docs/metric-definitions.md): Definitions of the default metrics Umami collects, including event, session, location, UTM, ad click ID, Web Vitals, and calculated metrics.
- [Integrations](/docs/integrations.md): A list of community plugins, API clients, and libraries for using Umami with frameworks and platforms such as WordPress, Nuxt, Gatsby, and Flutter.
- [MCP](/docs/mcp.md): Connect Claude, ChatGPT, Cursor, and other AI tools to your Umami analytics with the official Model Context Protocol server, on Umami Cloud or a self-hosted instance.
- [Contributing](/docs/contributing.md): Contribute code to Umami by branching from dev, opening pull requests against dev, and following the guidelines for reporting issues.
- [Code of Conduct](/docs/code-of-conduct.md): Read the Umami community code of conduct, including expected behavior, its scope, how to report violations, and how it is enforced.
- [Overview](/docs/guides.md): Hands-on guides for working with Umami, covering tracking techniques, developer workflows, team administration, hosting, and migrations.
- [Track outbound links](/docs/guides/track-outbound-links.md): Track clicks on links to external sites as Umami events, using data attributes on each link or a script that tags all outbound links.
- [Track a single-page application](/docs/guides/track-single-page-apps.md): Add the Umami tracker to React, Next.js, Vue, Nuxt, and Angular apps, which records client-side route changes as page views automatically.
- [Track file downloads](/docs/guides/track-file-downloads.md): Record file downloads as Umami custom events with data attributes on download links, or with a script that tags every file link automatically.
- [Track form submissions](/docs/guides/track-form-submissions.md): Track form submissions in Umami with data attributes on submit buttons or umami.track() calls, including multi-step forms and goals.
- [Identify logged-in users](/docs/guides/identify-logged-in-users.md): Link page views and events to logged-in users with umami.identify() and a Distinct ID, then view each user's sessions across devices.
- [Set up A/B testing with tags](/docs/guides/setup-ab-testing.md): Run simple A/B tests in Umami by giving each page variant its own data-tag value and comparing the variants with filters, Breakdown, and goals.
- [Embed analytics in your app](/docs/guides/embed-analytics-in-your-app.md): Embed Umami analytics in your own application with an iframe share URL, direct calls to the Umami API, or the Umami API client.
- [Send server-side events](/docs/guides/send-server-side-events.md): Send events to Umami from backend services with the Node client or the /api/send and /api/batch endpoints, such as payment webhooks.
- [Automate reporting with the API](/docs/guides/automate-reporting-with-api.md): Pull stats from the Umami API on a schedule to build daily summaries, top pages reports, weekly comparisons, and Slack notifications.
- [Set up team workspaces](/docs/guides/setup-team-workspaces.md): Create Umami teams to organize websites by client, department, or project, invite members with access codes or email, and assign roles.
- [Create a public dashboard](/docs/guides/create-a-public-dashboard.md): Share Umami analytics publicly with a website share URL or a custom board, and embed either one on your own site in an iframe.
- [Hosting](/docs/guides/hosting.md): An overview of ways to host Umami, from a single server to app hosting providers, plus managed PostgreSQL database providers you can use.
- [Running on bunny.net](/docs/guides/running-on-bunny.md): Deploy Umami and a PostgreSQL container together on bunny.net Magic Containers, with a persistent volume for data and a CDN endpoint.
- [Running on CapRover](/docs/guides/running-on-caprover.md): Deploy Umami on CapRover with a one-click app, either with a bundled PostgreSQL database or connected to a PostgreSQL database you run yourself.
- [Running on Cloudzy](/docs/guides/running-on-cloudzy.md): Launch a preconfigured Umami VPS on Cloudzy with Docker Compose, PostgreSQL, and Nginx, then configure a domain and start collecting data.
- [Running on DigitalOcean](/docs/guides/running-on-digitalocean.md): Self-host Umami on a DigitalOcean droplet with Ubuntu, PostgreSQL, Node.js, PM2, and an Nginx reverse proxy, with optional SSL from Let's Encrypt.
- [Running on Fly.io](/docs/guides/running-on-fly-io.md): Deploy Umami's prebuilt Docker image on Fly.io with a fly.toml file and a connected PostgreSQL app created during fly launch.
- [Running on Forge](/docs/guides/running-on-forge.md): Deploy Umami on a Laravel Forge server with a PostgreSQL database, a pnpm deployment script, an Nginx proxy, and a daemon to keep it running.
- [Running on Heroku](/docs/guides/running-on-heroku.md): Deploy Umami on Heroku from a fork of the GitHub repository, with a Heroku Postgres add-on for the database and an APP_SECRET config var.
- [Running on Koyeb](/docs/guides/running-on-koyeb.md): Deploy the Umami Docker image on Koyeb with the Koyeb CLI, using secrets for the PostgreSQL connection string and APP_SECRET.
- [Running on Kubernetes with HelmForge](/docs/guides/running-on-helmforge.md): Install Umami on Kubernetes with the third-party HelmForge Helm chart, using a bundled or external PostgreSQL database and optional Ingress.
- [Running on Neon Postgres](/docs/guides/running-on-neon.md): Use a Neon serverless PostgreSQL database for Umami, with a pooled connection string for the app and a direct connection for migrations.
- [Running on Netlify](/docs/guides/running-on-netlify.md): Deploy Umami to Netlify from a fork of the GitHub repository, using pnpm build as the build command and a remote PostgreSQL database.
- [Running on Nodion](/docs/guides/running-on-nodion.md): Launch Umami on Nodion with the 1-Click Deploy option, which creates the application and a managed PostgreSQL database in your chosen region.
- [Running on Northflank](/docs/guides/running-on-northflank.md): Deploy Umami on Northflank with a managed PostgreSQL addon, using the one-click stack or a manually configured deployment service.
- [Running on Qovery](/docs/guides/running-on-qovery.md): Deploy Umami on Qovery from your GitHub or GitLab repository, with a PostgreSQL database configured through Qovery environment variables.
- [Running on Railway](/docs/guides/running-on-railway.md): Deploy Umami on Railway with a PostgreSQL database, either from the one-click Railway template or from your own fork of the repository.
- [Running on Sevalla](/docs/guides/running-on-sevalla.md): Deploy Umami on Sevalla with a PostgreSQL database, using the one-click template or a manual deployment from the GitHub repository.
- [Running on Supabase](/docs/guides/running-on-supabase.md): Use a Supabase PostgreSQL database for Umami, with a pooled connection string for the app and a direct connection string for migrations.
- [Running on Vercel](/docs/guides/running-on-vercel.md): Deploy Umami to Vercel from a fork of the GitHub repository with a PostgreSQL database, and optionally proxy the tracker through your own domain.
- [Migrate v1 to v2](/docs/guides/migrate-v1-v2.md): Breaking changes between Umami v1 and v2, and how to convert a v1 database to the v2 schema with the @umami/migrate-v1-v2 script.
- [Migrate MySQL to PostgreSQL](/docs/guides/migrate-mysql-postgresql.md): Move an Umami v2 MySQL database to PostgreSQL before upgrading to v3, using either a MySQL dump file or CSV exports imported with psql.
- [Overview](/docs/api.md): Pull your analytics data from the Umami API, either from a self-hosted instance or from Umami Cloud using an API key.
- [Authentication](/docs/api/authentication.md): Authenticate Umami API requests with an API key or by exchanging a username and password for a token, including two-factor sign-in.
- [Sending stats](/docs/api/sending-stats.md): Send pageviews, custom events, and visitor data to Umami directly over HTTP with the /api/send and /api/batch endpoints.
- [Common endpoints](/docs/api/common-endpoints.md): A shortcut to the Umami API endpoints most integrations use, from listing websites to stats, time series, breakdowns, and realtime data.
- [Change my password](/docs/api-reference/update-my-password.md): Verifies the current password and replaces it with the supplied new password.
- [Create an API key](/docs/api-reference/create-my-api-key.md): Creates a named API key for the current user and returns its secret value. Available on self-hosted installations.
- [Delete an API key](/docs/api-reference/delete-my-api-key.md): Deletes an API key belonging to the current user, revoking its access. Available on self-hosted installations.
- [Get my authentication details](/docs/api-reference/get-me.md): Returns the current authentication context, including the authenticated user or share credentials.
- [List my API keys](/docs/api-reference/get-my-api-keys.md): Returns metadata for the current user's API keys. Available on self-hosted installations.
- [List my team memberships](/docs/api-reference/get-my-teams.md): Returns a paginated list of teams the current user belongs to, with sorting options.
- [List my websites](/docs/api-reference/get-my-websites.md): Returns a paginated list of the current user's websites, optionally including websites accessible through team membership.
- [Get a user's two-factor status](/docs/api-reference/get-admin-users-user-id2fa.md): Returns whether two-factor authentication is enabled for the specified user.
- [List all teams](/docs/api-reference/get-admin-teams.md): Returns a paginated list of teams with member details and website and member counts for administration.
- [List all users](/docs/api-reference/get-admin-users.md): Returns a paginated list of users and their website counts for administration, excluding passwords.
- [List all websites](/docs/api-reference/get-admin-websites.md): Returns a paginated, searchable list of websites across users and teams for administration.
- [Reset a user's two-factor authentication](/docs/api-reference/delete-admin-users-user-id2fa.md): Removes the specified user's authenticator setup, backup codes, used-code history, and failed-attempt limits so they can set up authentication again.
- [Set a team's two-factor requirement](/docs/api-reference/post-admin-teams-team-id2fa.md): Enables or disables the requirement for members of the specified team to use two-factor authentication.
- [Set a user's two-factor requirement](/docs/api-reference/post-admin-users-user-id2fa.md): Enables or disables the requirement for the specified user to set up two-factor authentication.
- [Set the two-factor requirement for everyone](/docs/api-reference/post-admin2fa-global.md): Enables or disables the installation-wide requirement for users to set up two-factor authentication.
- [List website annotations](/docs/api-reference/get-website-annotations.md): Returns a paginated list of dated notes for the website, optionally filtered by date range or search text.
- [Create a website annotation](/docs/api-reference/create-website-annotation.md): Adds a dated note to the website, optionally marking it as an all-day annotation.
- [Get a website annotation](/docs/api-reference/get-website-annotation.md): Returns the date, all-day setting, and note for a specific website annotation.
- [Update a website annotation](/docs/api-reference/update-website-annotation.md): Changes the date, all-day setting, and note for a website annotation.
- [Delete a website annotation](/docs/api-reference/delete-website-annotation.md): Deletes the specified dated note from the website.
- [Create a single sign-on token](/docs/api-reference/sso.md): Returns the authenticated user and a new token valid for 24 hours. Requires Redis-backed authentication.
- [Get subscription details](/docs/api-reference/get-subscription.md): Returns subscription and feature availability for the current user or a specified team the user can access.
- [Log in](/docs/api-reference/login.md): Authenticates a user with a username and password. Users with two-factor authentication receive a short-lived partial token to complete sign-in.
- [Log out](/docs/api-reference/logout.md): Ends the current authentication session by removing its stored token when Redis-backed sessions are enabled.
- [Verify the current sign-in](/docs/api-reference/verify.md): Validates the current authentication credentials and returns the user and their team memberships.
- [Get website attribution](/docs/api-reference/get-website-attribution.md): Attributes conversions for a page path or custom event to referrers, paid ads, and UTM parameters using a first-click or last-click model.
- [Clone a board](/docs/api-reference/clone-board.md): Creates a copy of a board with optional changes to its name, description, and configuration. Removes invalid report references from the copy.
- [Create a board](/docs/api-reference/create-board.md): Creates a board with a name, type, and configuration, optionally assigned to a team. Validates access to its referenced resources and reports.
- [Create a share for a board](/docs/api-reference/create-board-share.md): Creates a named share for the specified board with optional parameters.
- [Delete a board](/docs/api-reference/delete-board.md): Deletes the specified board after checking the caller's permission to remove it.
- [Get a board](/docs/api-reference/get-board.md): Returns the specified board and its configuration.
- [List my boards](/docs/api-reference/get-boards.md): Returns a paginated list of the current user's boards, with search and sorting options.
- [List shares for a board](/docs/api-reference/get-board-shares.md): Returns a paginated list of shares for the specified board.
- [Update a board](/docs/api-reference/update-board.md): Updates a board's name, description, or configuration and validates the resources and reports it references.
- [Get website breakdown](/docs/api-reference/get-website-breakdown.md): Returns pageviews, visitors, visits, bounces, and total time for the website, grouped by the requested fields, over the date range.
- [Send a batch of tracking requests](/docs/api-reference/batch.md): Processes up to 500 tracking payloads and returns processed and failed counts, individual error details, and a tracking cache token.
- [Send session recordings or heatmap data](/docs/api-reference/record.md): Stores session replay events or heatmap clicks and scrolls for a website, using a valid tracking cache token to identify the session and visit.
- [Send tracking data](/docs/api-reference/send.md): Collects a pageview, custom event, visitor identification, or performance payload and returns session information and a tracking cache token when accepted.
- [Get my dashboard](/docs/api-reference/get-dashboard.md): Returns the current user's personal dashboard board and its configuration.
- [Save my dashboard](/docs/api-reference/post-dashboard.md): Creates or updates the current user's personal dashboard with the supplied name, description, and configuration.
- [List events with custom properties](/docs/api-reference/get-event-data.md): Returns a page of events in the selected date range, grouping each event's custom property records together.
- [List event properties in table form](/docs/api-reference/get-event-data-pivot.md): Returns a page of occurrences of the specified event, with event details and property keys and values grouped into one row per occurrence.
- [Get event array values over time](/docs/api-reference/get-event-data-array-series.md): Counts individual values in an array property for the specified event, grouped by value and time interval.
- [Get the distribution of event date values](/docs/api-reference/get-event-data-date-series.md): Counts occurrences of dates stored in the specified event property, grouping by the property's date value within the selected event date range.
- [Get numeric event properties over time](/docs/api-reference/get-event-data-numeric-series.md): Returns the sum, average, or count of a numeric property for the specified event, grouped by time interval.
- [Get numeric event property statistics](/docs/api-reference/get-event-data-numeric-stats.md): Returns the total, average, median, minimum, and maximum of the specified numeric event property for the selected date range and filters.
- [Get event property values over time](/docs/api-reference/get-event-data-property-series.md): Counts occurrences of string values in the specified event property, grouped by value and time interval.
- [Get an event's custom properties](/docs/api-reference/get-event-data-by-id.md): Returns the custom property records, data types, and values attached to a specific event.
- [Summarize properties by event](/docs/api-reference/get-event-data-events.md): Returns property names, types, and counts grouped by event name. When an event is specified, also groups by property value.
- [List event property fields](/docs/api-reference/get-event-data-fields.md): Returns property names, data types, and counts for the selected date range, optionally restricted to an event name.
- [List event property usage](/docs/api-reference/get-event-data-properties.md): Returns event names and their custom property names, data types, and record counts for the selected date range and filters.
- [Get event property totals](/docs/api-reference/get-event-data-stats.md): Returns counts of events with custom data, distinct property names, and property records for the selected date range and filters.
- [List event property values](/docs/api-reference/get-event-data-values.md): Returns values and their occurrence counts for a custom event property, optionally restricted by event name and data type.
- [List tracked events](/docs/api-reference/get-website-events.md): Returns a page of pageviews and custom events in the date range, newest first. Supports filtering by event name and searching event details.
- [Get custom event counts over time](/docs/api-reference/get-website-event-series.md): Returns counts grouped by event name and time interval, optionally limited to the most frequent event names.
- [Get website event statistics](/docs/api-reference/get-website-event-stats.md): Returns website event totals for the selected date range and filters, including totals for the comparison period.
- [Get website funnels](/docs/api-reference/get-website-funnels.md): Returns a paginated list of the saved funnels for the website, optionally filtered by search text.
- [Create a website funnel](/docs/api-reference/create-website-funnel.md): Saves a named funnel for the website with an optional description, its ordered steps, and the conversion window.
- [Get a website funnel](/docs/api-reference/get-website-funnel.md): Returns a saved funnel for the website, including its name, description, steps, and conversion window.
- [Update a website funnel](/docs/api-reference/update-website-funnel.md): Updates the name, description, steps, or conversion window of a saved funnel for the website.
- [Delete a website funnel](/docs/api-reference/delete-website-funnel.md): Deletes the specified saved funnel from the website after checking the caller's permissions.
- [Get website funnel stats](/docs/api-reference/get-website-funnel-stats.md): Returns visitor counts and drop-off for each step of an ad-hoc funnel, given its steps and conversion window, over the date range.
- [Get website saved funnel stats](/docs/api-reference/get-website-saved-funnel-stats.md): Returns visitor counts and drop-off for each step of a saved funnel over the selected date range, with optional filters.
- [Get website goals](/docs/api-reference/get-website-goals.md): Returns a paginated list of the saved goals for the website, optionally filtered by search text.
- [Create a website goal](/docs/api-reference/create-website-goal.md): Saves a named goal for the website with an optional description and the goal type and value to track.
- [Get a website goal](/docs/api-reference/get-website-goal.md): Returns a saved goal for the website, including its name, description, and the type and value it tracks.
- [Update a website goal](/docs/api-reference/update-website-goal.md): Updates the name, description, or the type and value tracked by a saved goal for the website.
- [Delete a website goal](/docs/api-reference/delete-website-goal.md): Deletes the specified saved goal from the website after checking the caller's permissions.
- [Get website goal stats](/docs/api-reference/get-website-goal-stats.md): Returns the number of conversions and the total for an ad-hoc goal, given its type and value, over the selected date range.
- [Get website saved goal stats](/docs/api-reference/get-website-saved-goal-stats.md): Returns the number of conversions and the total for a saved goal over the selected date range, with optional filters.
- [Get website heatmaps](/docs/api-reference/get-website-heatmaps.md): Returns click or scroll heatmap data for the website, optionally for a single page path, along with the pages that have recorded data.
- [Get website journeys](/docs/api-reference/get-website-journeys.md): Returns the most common paths visitors take through the website, between 2 and 7 steps long, with optional start and end steps.
- [Create a share for a link](/docs/api-reference/create-link-share.md): Creates a named share for the specified link with optional parameters.
- [Create a tracked link](/docs/api-reference/create-link.md): Creates a tracked link with a name, destination URL, and slug, optionally assigned to a team.
- [Delete a tracked link](/docs/api-reference/delete-link.md): Deletes the specified tracked link after checking the caller's permission to remove it.
- [Get a tracked link](/docs/api-reference/get-link.md): Returns the specified tracked link, including its destination URL and slug.
- [Get visitor charts for links](/docs/api-reference/get-links-charts.md): Returns visitor totals and chart data for the requested links the caller can view, within the selected date range.
- [List my links](/docs/api-reference/get-links.md): Returns a paginated list of the current user's tracked links, with search and sorting options.
- [List shares for a link](/docs/api-reference/get-link-shares.md): Returns a paginated list of shares for the specified link.
- [Update a tracked link](/docs/api-reference/update-link.md): Updates a tracked link's name, destination URL, or slug.
- [Get website performance chart](/docs/api-reference/get-website-performance-chart.md): Returns p50, p75, and p95 values over time for a Core Web Vitals metric such as LCP, INP, CLS, FCP, or TTFB.
- [Get website performance metrics](/docs/api-reference/get-website-performance-metrics.md): Ranks pages, titles, devices, or browsers by a Core Web Vitals metric, with p50, p75, and p95 values and a measurement count.
- [Get website performance stats](/docs/api-reference/get-website-performance-stats.md): Returns p50, p75, and p95 values for LCP, INP, CLS, FCP, and TTFB and the number of measurements in the date range.
- [Create a share for a tracking pixel](/docs/api-reference/create-pixel-share.md): Creates a named share for the specified tracking pixel with optional parameters.
- [Create a tracking pixel](/docs/api-reference/create-pixel.md): Creates a tracking pixel with a name and slug, optionally assigned to a team.
- [Delete a tracking pixel](/docs/api-reference/delete-pixel.md): Deletes the specified tracking pixel after checking the caller's permission to remove it.
- [Get a tracking pixel](/docs/api-reference/get-pixel.md): Returns the specified tracking pixel and its configuration.
- [Get visitor charts for tracking pixels](/docs/api-reference/get-pixels-charts.md): Returns visitor totals and chart data for the requested pixels the caller can view, within the selected date range.
- [List my tracking pixels](/docs/api-reference/get-pixels.md): Returns a paginated list of the current user's tracking pixels, with search and sorting options.
- [List shares for a tracking pixel](/docs/api-reference/get-pixel-shares.md): Returns a paginated list of shares for the specified tracking pixel.
- [Update a tracking pixel](/docs/api-reference/update-pixel.md): Updates a tracking pixel's name or slug.
- [Get website retention](/docs/api-reference/get-website-retention.md): Returns daily retention for the website: for each first-visit date, how many visitors returned on later days and the percentage.
- [Get real-time website activity](/docs/api-reference/get-realtime.md): Returns recent website activity and visitor data for the real-time view, applying the supplied filters.
- [Get website revenue over time](/docs/api-reference/get-website-revenue-chart.md): Returns revenue chart data for the selected currency, date range, and website filters.
- [Get website revenue by dimension](/docs/api-reference/get-website-revenue-metrics.md): Returns revenue grouped by the requested dimension, such as country or referrer, for the selected currency and date range.
- [Get website revenue totals](/docs/api-reference/get-website-revenue-stats.md): Returns revenue summary statistics for the selected currency and date range, including totals for the comparison period.
- [List sessions with revenue](/docs/api-reference/get-website-revenue-sessions.md): Returns a paginated list of sessions with revenue in the selected currency and date range, applying website and search filters.
- [Get the installation telemetry script](/docs/api-reference/get-scripts-telemetry.md): Returns JavaScript that sends the application version through a telemetry pixel, or an inactive script when telemetry is disabled.
- [List website segments and cohorts](/docs/api-reference/get-website-segments.md): Returns saved segments or cohorts for the website, filtered by the requested type and search text.
- [Create a website segment or cohort](/docs/api-reference/create-website-segment.md): Saves a named segment or cohort with its type and filter parameters for the website.
- [Get a website segment or cohort](/docs/api-reference/get-website-segment.md): Returns a saved segment or cohort and its filter parameters for the website.
- [Update a website segment or cohort](/docs/api-reference/update-website-segment.md): Updates a saved segment or cohort's type, name, and filter parameters.
- [Delete a website segment or cohort](/docs/api-reference/delete-website-segment.md): Deletes the specified saved segment or cohort from the website.
- [List session properties in table form](/docs/api-reference/get-session-data-pivot.md): Returns a page of sessions matching the selected property and filters, with the latest property keys and values grouped into one row per session.
- [Get session array values over time](/docs/api-reference/get-session-data-array-series.md): Counts distinct sessions for individual values in an array property, grouped by value and time interval.
- [Get the distribution of session date values](/docs/api-reference/get-session-data-date-series.md): Counts distinct sessions by dates stored in the specified custom property, using the selected date range and filters.
- [Get numeric session properties over time](/docs/api-reference/get-session-data-numeric-series.md): Returns the sum, average, or count of a numeric session property, grouped by time interval for the selected date range and filters.
- [Get numeric session property statistics](/docs/api-reference/get-session-data-numeric-stats.md): Returns the total, average, median, minimum, and maximum of the specified numeric session property for the selected date range and filters.
- [List session property usage](/docs/api-reference/get-session-data-properties.md): Returns custom session property names, data types, and distinct session counts, optionally restricted to sessions with a selected property.
- [Get session property values over time](/docs/api-reference/get-session-data-property-series.md): Counts distinct sessions for string values in a custom property, grouped by value and time interval.
- [Get activity by session property](/docs/api-reference/get-session-data-stats.md): Returns session, visit, pageview, event, and total activity counts grouped by values of the specified session property.
- [List session property values](/docs/api-reference/get-session-data-values.md): Returns custom session property values and their occurrence counts, optionally filtered by property name and data type.
- [Get website recording settings](/docs/api-reference/get-website-recorder-config.md): Returns public replay and heatmap settings, including sampling, masking, and duration limits. Returns disabled status when recording is unavailable.
- [List website session replays](/docs/api-reference/get-website-replays.md): Returns a paginated list of recorded sessions for the website, applying date, replay, and search filters.
- [Get a session replay recording](/docs/api-reference/get-website-replay.md): Returns the merged recording events, session details, and event and chunk counts for a replay, with optional stopping points by timestamp, chunk, or event index.
- [List saved session replays](/docs/api-reference/get-website-saved-replays.md): Returns a paginated, searchable list of replays saved for the website.
- [Check whether a replay is saved](/docs/api-reference/get-website-replay-saved.md): Returns whether the specified replay is in the website's saved replays.
- [Save or unsave a session replay](/docs/api-reference/save-website-replay.md): Adds a replay to the website's saved replays with an optional name, or removes it when isSaved is false.
- [List visitor sessions](/docs/api-reference/get-website-sessions.md): Returns a page of visitor sessions in the date range, newest first. Search matches distinct ID, city, browser, operating system, or device.
- [Get a visitor session](/docs/api-reference/get-website-session.md): Returns details for a website session, including linked visitor identities and whether session deletion is available to the caller.
- [Delete a visitor session](/docs/api-reference/delete-website-session.md): Deletes the specified session and its associated analytics data. Available on installations using only a relational database.
- [Get visitor session statistics](/docs/api-reference/get-website-session-stats.md): Returns aggregate session metrics for the website over the selected date range and filters.
- [Get traffic by weekday and hour](/docs/api-reference/get-website-sessions-weekly.md): Returns distinct visitor counts grouped by day of the week and hour in the selected timezone and date range.
- [Get a visitor's session activity](/docs/api-reference/get-website-session-activity.md): Returns activity for the specified session and sessions linked by visitor identity, using the requested date range and optional distinct ID.
- [Get a session's custom properties](/docs/api-reference/get-website-session-properties.md): Returns custom property records, data types, and values for the specified website session.
- [List a visitor's session replays](/docs/api-reference/get-website-session-replays.md): Returns a paginated, searchable list of recordings for the specified website session.
- [Create a share](/docs/api-reference/create-share.md): Creates a named share for a website, board, link, or pixel with parameters and an optional custom slug.
- [Delete a share](/docs/api-reference/delete-share.md): Deletes the specified share after checking permission to delete shares for its resource.
- [Get a share](/docs/api-reference/get-share.md): Returns a share's configuration by its ID after checking access to the shared resource.
- [Open a share by its slug](/docs/api-reference/get-share-by-slug.md): Resolves a public share slug and returns its resource references, parameters, and an access token scoped to the shared resources.
- [Update a share](/docs/api-reference/update-share.md): Updates the specified share's name, slug, and parameters.
- [Get active website visitors](/docs/api-reference/get-website-active.md): Returns the number of visitors active on the website in the last few minutes.
- [Get ranked website metrics](/docs/api-reference/get-website-metrics.md): Returns the most frequent values for a dimension such as pages, referrers, countries, browsers, campaigns, or events. Counts pageviews or events for activity dimensions and unique visitors for visitor dimensions.
- [Get pageviews and sessions over time](/docs/api-reference/get-website-pageviews.md): Returns pageviews and sessions grouped by the requested time interval and timezone, including a comparison period when requested.
- [Get website summary statistics](/docs/api-reference/get-website-stats.md): Returns pageviews, unique visitors, visits, bounces, and total time on site for the selected date range and comparison period.
- [Get detailed website metrics](/docs/api-reference/get-website-expanded-metrics.md): Returns additional analytics for the selected page, event, visitor, or channel dimension, using the supplied date range and filters.
- [Check application availability](/docs/api-reference/get-heartbeat.md): Returns a simple success response to confirm that the application can serve requests.
- [Add a team member](/docs/api-reference/create-team-user.md): Adds an existing user to the specified team with the supplied team role.
- [Change a team member's role](/docs/api-reference/update-team-user.md): Updates a user's role in the specified team, subject to the caller's role and permissions.
- [Create a team](/docs/api-reference/create-team.md): Creates a team with an access code and an owner. Administrators can specify a different user as the owner.
- [Delete a team](/docs/api-reference/delete-team.md): Deletes the specified team after checking the caller's permission to remove it.
- [Get a team](/docs/api-reference/get-team.md): Returns the specified team's details, including its members.
- [Get a team member](/docs/api-reference/get-team-user.md): Returns the specified user's membership details for a team.
- [Join a team](/docs/api-reference/join-team.md): Adds the current user to a team as a member using the team's access code.
- [List a team's boards](/docs/api-reference/get-team-boards.md): Returns a paginated list of boards belonging to the specified team, with search and sorting options.
- [List a team's links](/docs/api-reference/get-team-links.md): Returns a paginated list of tracked links belonging to the specified team, with search and sorting options.
- [List a team's tracking pixels](/docs/api-reference/get-team-pixels.md): Returns a paginated list of tracking pixels belonging to the specified team, with search and sorting options.
- [List a team's websites](/docs/api-reference/get-team-websites.md): Returns a paginated list of websites belonging to the specified team, with search and sorting options.
- [List my teams](/docs/api-reference/get-teams.md): Returns a paginated list of teams the current user belongs to, with sorting options.
- [List team members](/docs/api-reference/get-team-users.md): Returns a paginated list of members of the specified team, including usernames and membership details.
- [Remove a team member](/docs/api-reference/delete-team-user.md): Removes a user's membership from the specified team, subject to team role and ownership restrictions.
- [Update a team](/docs/api-reference/update-team.md): Updates the specified team's name or access code.
- [Cancel two-factor authentication setup](/docs/api-reference/cancel-two-factor-setup.md): Deletes the current user's pending setup without changing an already enabled authenticator.
- [Complete two-factor sign-in](/docs/api-reference/verify-two-factor.md): Exchanges a partial sign-in token and a valid authenticator or backup code for a full authentication token and user details.
- [Confirm two-factor authentication setup](/docs/api-reference/confirm-two-factor-setup.md): Verifies an authenticator code, enables two-factor authentication, and returns a new set of backup codes.
- [Disable two-factor authentication](/docs/api-reference/disable-two-factor.md): Disables two-factor authentication for the current user after verifying their password and authenticator code. Rejected when an administrator or team requires it.
- [Get two-factor authentication status](/docs/api-reference/get-two-factor-status.md): Returns whether two-factor authentication is enabled, configured, or required for the current user, including the reason it is required.
- [Set up two-factor authentication](/docs/api-reference/initiate-two-factor-setup.md): Starts or replaces the current user's pending setup and returns a QR code and manual setup key for an authenticator app.
- [Create a user](/docs/api-reference/create-user.md): Creates a user account with the supplied username, password, and role.
- [Delete a user](/docs/api-reference/delete-user.md): Deletes the specified user account. The current user cannot delete their own account through this operation.
- [Get a user](/docs/api-reference/get-user.md): Returns details for the specified user account when the caller has permission to view it.
- [List a user's teams](/docs/api-reference/get-user-teams.md): Returns a paginated list of teams for the specified user. Available to that user and administrators.
- [List a user's websites](/docs/api-reference/get-user-websites.md): Returns a paginated list of the specified user's websites, optionally including team access. Available to that user and administrators.
- [Update a user](/docs/api-reference/update-user.md): Updates a user's password. Administrators can also change the username and role.
- [Get website UTM metrics](/docs/api-reference/get-website-utm-metrics.md): Returns pageview counts grouped by a UTM parameter, such as source, medium, campaign, term, or content, for the selected date range.
- [List websites](/docs/api-reference/list-websites.md): Returns a paginated list of the current user's websites, optionally including websites accessible through team membership.
- [Create a website](/docs/api-reference/create-website.md): Creates a website with a name and domain, optionally assigning it to a team and creating a share.
- [Get a website](/docs/api-reference/get-website.md): Returns the specified website's details and configuration.
- [Update a website](/docs/api-reference/update-website.md): Updates a website's name, domain, sharing settings, or recording configuration.
- [Delete a website](/docs/api-reference/delete-website.md): Deletes the specified website after checking the caller's permission to remove it.
- [Get visitor charts for websites](/docs/api-reference/get-websites-charts.md): Returns visitor totals and chart data for the requested websites the caller can view, within the selected date range.
- [Get the website's available date range](/docs/api-reference/get-website-date-range.md): Returns the earliest and latest recorded event dates for the website.
- [Export website analytics](/docs/api-reference/export-website.md): Returns a base64-encoded ZIP archive containing CSV exports of events, pages, referrers, browsers, operating systems, devices, and countries.
- [Reset website analytics](/docs/api-reference/reset-website.md): Clears the website's collected analytics data while keeping the website configuration.
- [List shares for a website](/docs/api-reference/get-website-shares.md): Returns a paginated list of shares for the specified website.
- [Create a share for a website](/docs/api-reference/create-website-share.md): Creates a named share for the specified website with optional parameters.
- [Transfer website ownership](/docs/api-reference/transfer-website.md): Transfers the specified website to another user or team after checking permission for the destination.
- [List website filter values](/docs/api-reference/get-website-values.md): Returns available values for a website filter, including saved segments or cohorts when requested, to populate filter choices.
- [API client](/docs/api/api-client.md): Call the Umami API from TypeScript or JavaScript with the @umami/api-client package, on a self-hosted instance or Umami Cloud.
- [Node Client](/docs/api/node-client.md): Send pageviews and custom events to Umami from your server with the @umami/node client for Node.js.
- [Overview](/docs/cloud.md): Umami Cloud is the hosted version of Umami, run by its creators. Compare its features and plans with the self-hosted, open-source platform.
- [Sign up](/docs/cloud/sign-up.md): Sign up for a free Umami Cloud account, verify your email address, and complete the account setup by selecting your data region.
- [Login](/docs/cloud/login.md): Log into your Umami Cloud account, reset a forgotten password, and change your password from your account settings.
- [Teams](/docs/cloud/teams.md): Create teams in Umami Cloud to organize users and share websites, with roles, access codes, member invites, and website transfers.
- [Email reports](/docs/cloud/email-reports.md): Send scheduled Umami Cloud email reports with your website's top stats, pages, and referrers to anyone, starting at the Pro plan.
- [IP Filters](/docs/cloud/ip-filters.md): Block specific IP addresses or CIDR ranges in Umami Cloud to exclude traffic from offices, development environments, or bot networks.
- [White-label](/docs/cloud/white-label.md): Replace Umami branding on your share pages with your own logo, display name, and link using White-label, available on the Business plan.
- [Notifications](/docs/cloud/notifications.md): Turn off Umami Cloud email notifications about product features and updates from the Notifications section of your settings.
- [Delete account](/docs/cloud/delete-account.md): Permanently delete your Umami Cloud account and all of its websites, teams, and analytics data from your account settings.
- [FAQ](/docs/cloud/faq.md): Answers to common Umami Cloud questions about the free tier, free trials, billing, how usage is measured, server locations, and data export.
- [Subscription](/docs/cloud/subscription.md): Upgrade your Umami Cloud plan through Stripe, review estimated costs, set a monthly spending budget, and manage billing details.
- [Usage](/docs/cloud/usage.md): Track your Umami Cloud usage for the billing period, including total events, the split by data type, and top websites, pixels, and links.
- [API Key](/docs/cloud/api-key.md): Generate an Umami Cloud API key to access your analytics data through the API, and learn about regions, rate limits, and restricted routes.
- [MCP](/docs/cloud/mcp.md): Connect Claude, ChatGPT, Cursor, and other AI tools to your Umami Cloud analytics using the Model Context Protocol.
- [Export data](/docs/cloud/export-data.md): Export your Umami Cloud analytics data for a website to gzip-compressed CSV files, delivered as an emailed download link.
- [Import Data](/docs/cloud/import-data.md): Import historical analytics data into Umami Cloud from a self-hosted Umami instance or CSV exports, with the import handled by the Umami team.
- [Changelog](/docs/cloud/changelog.md): Notable changes to Umami Cloud and the Umami Cloud API, including new features, endpoint changes, and deprecations, listed by date.