# OnyxMetric

> Cookieless web and product analytics, fully managed.

## Machine-readable resources

- [OpenAPI specification](https://onyxmetric.com/openapi.json): Complete discoverable REST API surface
- [Sitemap](https://onyxmetric.com/sitemap.xml): Public website URL index
- [Full documentation](https://onyxmetric.com/llms-full.txt): Documentation in one text response
- [About OnyxMetric](https://onyxmetric.com/about): What it is and who builds it (Cuanto Labs, founder Eliran Yihye)
- [How we built OnyxMetric](https://onyxmetric.com/blog/how-we-built-onyxmetric): Engineering write-up by Eliran Yihye, founder and lead engineer
- [API getting started](https://onyxmetric.com/docs/api/getting-started): Authentication, time ranges, filters, and rate limits

Built by Cuanto Labs (https://cuantolabs.com), founder Eliran Yihye (https://cuantolabs.com/about/eliran-yihye).

## Documentation index

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/docs): Introduction to OnyxMetric
  - [Comparison](/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/docs/feature-guides/events): Track custom events on your website
    - [Globe](/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/de/docs): Introduction to OnyxMetric
  - [Comparison](/de/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/de/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/de/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/de/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/de/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/de/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/de/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/de/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/de/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/de/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/de/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/de/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/de/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/de/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/de/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/de/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/de/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/de/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/de/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/de/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/de/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/de/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/de/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/de/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/de/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/de/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/de/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/de/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/de/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/de/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/de/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/de/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/de/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/de/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/de/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/de/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/de/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/de/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/de/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/de/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/de/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/de/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/de/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/de/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/de/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/de/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/de/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/de/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/de/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/de/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/de/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/de/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/de/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/de/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/de/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/de/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/de/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/de/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/de/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/de/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/de/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/de/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/de/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/de/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/de/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/de/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/de/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/de/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/de/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/de/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/de/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/de/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/de/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/de/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/de/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/de/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/de/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/de/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/de/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/de/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/de/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/de/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/de/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/de/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/de/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/de/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/de/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/de/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/de/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/de/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/de/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/de/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/de/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/de/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/de/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/de/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/de/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/de/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/de/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/de/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/de/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/de/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/de/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/de/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/de/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/de/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/de/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/de/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/de/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/de/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/de/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/de/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/de/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/de/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/de/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/de/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/de/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/de/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/de/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/de/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/de/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/de/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/de/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/de/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/de/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/de/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/de/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/de/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/de/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/de/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/de/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/de/docs/feature-guides/events): Track custom events on your website
    - [Globe](/de/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/de/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/de/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/de/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/de/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/de/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/de/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/de/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/de/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/de/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/de/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/de/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/de/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/de/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/de/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/de/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/de/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/de/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/de/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/de/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/de/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/de/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/de/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/de/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/de/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/de/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/de/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/de/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/de/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/de/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/de/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/de/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/de/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/de/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/de/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/de/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/de/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/de/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/de/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/de/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/de/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/de/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/de/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/de/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/de/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/de/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/de/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/de/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/de/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/de/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/de/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/de/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/de/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/de/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/de/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/de/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/de/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/de/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/de/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/de/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/de/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/de/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/de/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/de/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/de/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/de/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/de/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/de/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/de/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/de/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/de/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/de/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/de/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/de/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/de/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/de/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/de/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/de/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/de/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/de/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/de/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/de/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/de/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/de/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/de/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/de/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/de/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/de/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/de/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/de/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/de/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/de/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/de/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/de/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/de/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/de/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/de/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/de/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/de/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/de/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/de/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/de/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/de/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/de/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/de/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/de/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/de/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/de/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/de/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/de/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/de/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/de/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/fr/docs): Introduction to OnyxMetric
  - [Comparison](/fr/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/fr/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/fr/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/fr/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/fr/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/fr/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/fr/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/fr/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/fr/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/fr/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/fr/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/fr/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/fr/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/fr/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/fr/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/fr/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/fr/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/fr/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/fr/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/fr/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/fr/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/fr/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/fr/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/fr/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/fr/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/fr/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/fr/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/fr/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/fr/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/fr/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/fr/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/fr/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/fr/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/fr/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/fr/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/fr/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/fr/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/fr/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/fr/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/fr/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/fr/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/fr/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/fr/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/fr/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/fr/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/fr/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/fr/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/fr/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/fr/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/fr/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/fr/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/fr/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/fr/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/fr/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/fr/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/fr/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/fr/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/fr/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/fr/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/fr/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/fr/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/fr/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/fr/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/fr/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/fr/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/fr/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/fr/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/fr/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/fr/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/fr/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/fr/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/fr/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/fr/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/fr/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/fr/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/fr/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/fr/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/fr/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/fr/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/fr/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/fr/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/fr/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/fr/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/fr/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/fr/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/fr/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/fr/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/fr/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/fr/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/fr/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/fr/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/fr/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/fr/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/fr/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/fr/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/fr/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/fr/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/fr/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/fr/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/fr/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/fr/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/fr/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/fr/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/fr/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/fr/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/fr/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/fr/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/fr/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/fr/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/fr/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/fr/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/fr/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/fr/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/fr/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/fr/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/fr/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/fr/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/fr/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/fr/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/fr/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/fr/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/fr/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/fr/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/fr/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/fr/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/fr/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/fr/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/fr/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/fr/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/fr/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/fr/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/fr/docs/feature-guides/events): Track custom events on your website
    - [Globe](/fr/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/fr/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/fr/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/fr/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/fr/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/fr/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/fr/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/fr/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/fr/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/fr/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/fr/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/fr/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/fr/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/fr/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/fr/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/fr/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/fr/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/fr/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/fr/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/fr/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/fr/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/fr/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/fr/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/fr/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/fr/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/fr/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/fr/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/fr/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/fr/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/fr/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/fr/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/fr/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/fr/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/fr/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/fr/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/fr/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/fr/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/fr/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/fr/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/fr/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/fr/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/fr/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/fr/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/fr/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/fr/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/fr/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/fr/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/fr/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/fr/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/fr/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/fr/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/fr/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/fr/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/fr/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/fr/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/fr/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/fr/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/fr/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/fr/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/fr/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/fr/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/fr/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/fr/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/fr/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/fr/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/fr/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/fr/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/fr/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/fr/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/fr/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/fr/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/fr/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/fr/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/fr/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/fr/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/fr/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/fr/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/fr/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/fr/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/fr/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/fr/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/fr/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/fr/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/fr/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/fr/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/fr/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/fr/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/fr/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/fr/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/fr/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/fr/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/fr/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/fr/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/fr/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/fr/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/fr/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/fr/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/fr/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/fr/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/fr/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/fr/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/fr/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/fr/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/fr/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/fr/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/fr/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/fr/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/fr/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/fr/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/fr/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/fr/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/fr/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/zh/docs): Introduction to OnyxMetric
  - [Comparison](/zh/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/zh/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/zh/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/zh/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/zh/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/zh/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/zh/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/zh/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/zh/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/zh/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/zh/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/zh/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/zh/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/zh/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/zh/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/zh/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/zh/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/zh/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/zh/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/zh/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/zh/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/zh/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/zh/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/zh/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/zh/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/zh/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/zh/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/zh/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/zh/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/zh/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/zh/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/zh/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/zh/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/zh/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/zh/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/zh/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/zh/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/zh/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/zh/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/zh/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/zh/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/zh/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/zh/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/zh/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/zh/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/zh/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/zh/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/zh/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/zh/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/zh/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/zh/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/zh/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/zh/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/zh/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/zh/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/zh/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/zh/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/zh/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/zh/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/zh/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/zh/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/zh/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/zh/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/zh/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/zh/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/zh/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/zh/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/zh/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/zh/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/zh/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/zh/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/zh/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/zh/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/zh/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/zh/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/zh/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/zh/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/zh/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/zh/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/zh/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/zh/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/zh/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/zh/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/zh/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/zh/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/zh/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/zh/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/zh/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/zh/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/zh/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/zh/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/zh/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/zh/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/zh/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/zh/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/zh/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/zh/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/zh/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/zh/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/zh/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/zh/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/zh/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/zh/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/zh/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/zh/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/zh/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/zh/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/zh/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/zh/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/zh/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/zh/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/zh/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/zh/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/zh/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/zh/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/zh/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/zh/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/zh/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/zh/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/zh/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/zh/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/zh/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/zh/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/zh/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/zh/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/zh/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/zh/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/zh/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/zh/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/zh/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/zh/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/zh/docs/feature-guides/events): Track custom events on your website
    - [Globe](/zh/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/zh/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/zh/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/zh/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/zh/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/zh/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/zh/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/zh/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/zh/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/zh/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/zh/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/zh/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/zh/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/zh/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/zh/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/zh/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/zh/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/zh/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/zh/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/zh/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/zh/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/zh/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/zh/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/zh/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/zh/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/zh/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/zh/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/zh/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/zh/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/zh/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/zh/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/zh/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/zh/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/zh/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/zh/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/zh/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/zh/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/zh/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/zh/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/zh/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/zh/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/zh/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/zh/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/zh/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/zh/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/zh/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/zh/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/zh/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/zh/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/zh/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/zh/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/zh/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/zh/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/zh/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/zh/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/zh/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/zh/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/zh/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/zh/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/zh/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/zh/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/zh/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/zh/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/zh/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/zh/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/zh/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/zh/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/zh/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/zh/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/zh/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/zh/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/zh/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/zh/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/zh/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/zh/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/zh/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/zh/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/zh/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/zh/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/zh/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/zh/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/zh/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/zh/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/zh/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/zh/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/zh/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/zh/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/zh/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/zh/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/zh/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/zh/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/zh/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/zh/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/zh/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/zh/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/zh/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/zh/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/zh/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/zh/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/zh/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/zh/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/zh/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/zh/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/zh/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/zh/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/zh/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/zh/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/zh/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/zh/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/zh/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/zh/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/zh/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/es/docs): Introduction to OnyxMetric
  - [Comparison](/es/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/es/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/es/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/es/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/es/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/es/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/es/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/es/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/es/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/es/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/es/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/es/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/es/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/es/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/es/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/es/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/es/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/es/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/es/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/es/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/es/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/es/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/es/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/es/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/es/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/es/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/es/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/es/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/es/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/es/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/es/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/es/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/es/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/es/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/es/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/es/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/es/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/es/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/es/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/es/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/es/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/es/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/es/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/es/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/es/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/es/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/es/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/es/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/es/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/es/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/es/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/es/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/es/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/es/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/es/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/es/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/es/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/es/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/es/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/es/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/es/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/es/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/es/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/es/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/es/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/es/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/es/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/es/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/es/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/es/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/es/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/es/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/es/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/es/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/es/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/es/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/es/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/es/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/es/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/es/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/es/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/es/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/es/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/es/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/es/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/es/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/es/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/es/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/es/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/es/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/es/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/es/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/es/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/es/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/es/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/es/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/es/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/es/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/es/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/es/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/es/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/es/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/es/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/es/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/es/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/es/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/es/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/es/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/es/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/es/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/es/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/es/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/es/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/es/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/es/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/es/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/es/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/es/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/es/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/es/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/es/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/es/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/es/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/es/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/es/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/es/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/es/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/es/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/es/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/es/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/es/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/es/docs/feature-guides/events): Track custom events on your website
    - [Globe](/es/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/es/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/es/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/es/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/es/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/es/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/es/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/es/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/es/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/es/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/es/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/es/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/es/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/es/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/es/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/es/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/es/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/es/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/es/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/es/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/es/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/es/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/es/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/es/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/es/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/es/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/es/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/es/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/es/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/es/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/es/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/es/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/es/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/es/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/es/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/es/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/es/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/es/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/es/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/es/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/es/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/es/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/es/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/es/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/es/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/es/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/es/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/es/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/es/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/es/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/es/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/es/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/es/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/es/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/es/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/es/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/es/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/es/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/es/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/es/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/es/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/es/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/es/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/es/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/es/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/es/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/es/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/es/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/es/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/es/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/es/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/es/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/es/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/es/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/es/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/es/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/es/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/es/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/es/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/es/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/es/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/es/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/es/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/es/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/es/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/es/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/es/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/es/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/es/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/es/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/es/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/es/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/es/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/es/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/es/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/es/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/es/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/es/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/es/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/es/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/es/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/es/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/es/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/es/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/es/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/es/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/es/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/es/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/es/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/es/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/es/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/es/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/pl/docs): Introduction to OnyxMetric
  - [Comparison](/pl/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/pl/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/pl/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/pl/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/pl/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/pl/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/pl/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/pl/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/pl/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/pl/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/pl/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/pl/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/pl/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/pl/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/pl/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/pl/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/pl/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/pl/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/pl/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/pl/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/pl/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/pl/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/pl/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/pl/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/pl/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/pl/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/pl/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/pl/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/pl/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/pl/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/pl/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/pl/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/pl/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/pl/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/pl/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/pl/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/pl/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/pl/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/pl/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/pl/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/pl/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/pl/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/pl/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/pl/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/pl/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/pl/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/pl/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/pl/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/pl/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/pl/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/pl/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/pl/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/pl/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/pl/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/pl/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/pl/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/pl/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/pl/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/pl/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/pl/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/pl/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/pl/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/pl/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/pl/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/pl/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/pl/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/pl/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/pl/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/pl/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/pl/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/pl/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/pl/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/pl/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/pl/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/pl/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/pl/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/pl/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/pl/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/pl/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/pl/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/pl/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/pl/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/pl/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/pl/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/pl/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/pl/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/pl/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/pl/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/pl/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/pl/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/pl/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/pl/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/pl/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/pl/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/pl/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/pl/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/pl/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/pl/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/pl/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/pl/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/pl/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/pl/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/pl/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/pl/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/pl/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/pl/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/pl/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/pl/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/pl/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/pl/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/pl/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/pl/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/pl/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/pl/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/pl/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/pl/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/pl/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/pl/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/pl/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/pl/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/pl/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/pl/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/pl/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/pl/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/pl/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/pl/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/pl/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/pl/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/pl/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/pl/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/pl/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/pl/docs/feature-guides/events): Track custom events on your website
    - [Globe](/pl/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/pl/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/pl/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/pl/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/pl/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/pl/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/pl/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/pl/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/pl/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/pl/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/pl/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/pl/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/pl/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/pl/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/pl/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/pl/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/pl/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/pl/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/pl/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/pl/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/pl/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/pl/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/pl/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/pl/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/pl/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/pl/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/pl/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/pl/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/pl/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/pl/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/pl/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/pl/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/pl/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/pl/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/pl/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/pl/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/pl/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/pl/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/pl/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/pl/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/pl/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/pl/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/pl/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/pl/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/pl/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/pl/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/pl/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/pl/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/pl/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/pl/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/pl/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/pl/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/pl/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/pl/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/pl/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/pl/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/pl/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/pl/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/pl/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/pl/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/pl/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/pl/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/pl/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/pl/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/pl/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/pl/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/pl/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/pl/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/pl/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/pl/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/pl/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/pl/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/pl/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/pl/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/pl/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/pl/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/pl/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/pl/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/pl/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/pl/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/pl/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/pl/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/pl/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/pl/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/pl/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/pl/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/pl/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/pl/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/pl/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/pl/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/pl/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/pl/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/pl/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/pl/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/pl/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/pl/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/pl/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/pl/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/pl/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/pl/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/pl/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/pl/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/pl/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/pl/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/pl/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/pl/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/pl/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/pl/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/pl/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/pl/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/pl/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/pl/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/it/docs): Introduction to OnyxMetric
  - [Comparison](/it/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/it/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/it/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/it/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/it/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/it/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/it/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/it/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/it/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/it/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/it/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/it/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/it/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/it/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/it/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/it/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/it/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/it/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/it/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/it/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/it/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/it/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/it/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/it/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/it/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/it/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/it/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/it/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/it/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/it/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/it/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/it/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/it/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/it/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/it/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/it/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/it/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/it/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/it/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/it/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/it/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/it/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/it/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/it/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/it/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/it/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/it/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/it/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/it/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/it/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/it/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/it/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/it/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/it/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/it/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/it/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/it/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/it/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/it/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/it/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/it/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/it/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/it/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/it/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/it/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/it/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/it/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/it/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/it/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/it/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/it/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/it/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/it/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/it/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/it/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/it/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/it/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/it/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/it/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/it/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/it/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/it/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/it/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/it/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/it/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/it/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/it/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/it/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/it/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/it/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/it/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/it/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/it/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/it/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/it/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/it/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/it/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/it/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/it/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/it/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/it/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/it/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/it/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/it/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/it/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/it/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/it/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/it/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/it/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/it/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/it/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/it/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/it/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/it/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/it/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/it/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/it/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/it/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/it/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/it/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/it/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/it/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/it/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/it/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/it/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/it/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/it/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/it/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/it/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/it/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/it/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/it/docs/feature-guides/events): Track custom events on your website
    - [Globe](/it/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/it/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/it/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/it/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/it/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/it/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/it/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/it/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/it/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/it/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/it/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/it/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/it/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/it/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/it/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/it/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/it/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/it/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/it/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/it/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/it/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/it/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/it/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/it/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/it/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/it/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/it/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/it/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/it/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/it/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/it/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/it/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/it/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/it/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/it/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/it/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/it/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/it/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/it/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/it/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/it/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/it/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/it/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/it/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/it/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/it/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/it/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/it/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/it/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/it/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/it/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/it/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/it/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/it/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/it/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/it/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/it/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/it/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/it/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/it/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/it/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/it/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/it/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/it/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/it/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/it/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/it/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/it/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/it/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/it/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/it/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/it/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/it/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/it/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/it/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/it/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/it/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/it/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/it/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/it/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/it/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/it/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/it/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/it/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/it/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/it/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/it/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/it/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/it/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/it/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/it/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/it/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/it/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/it/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/it/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/it/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/it/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/it/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/it/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/it/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/it/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/it/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/it/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/it/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/it/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/it/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/it/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/it/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/it/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/it/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/it/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/it/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/ko/docs): Introduction to OnyxMetric
  - [Comparison](/ko/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/ko/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/ko/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/ko/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/ko/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/ko/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/ko/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/ko/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/ko/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/ko/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/ko/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/ko/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/ko/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/ko/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/ko/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/ko/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/ko/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/ko/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/ko/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/ko/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/ko/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/ko/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/ko/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/ko/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/ko/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/ko/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/ko/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/ko/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/ko/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/ko/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/ko/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/ko/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/ko/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/ko/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/ko/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/ko/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/ko/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/ko/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/ko/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/ko/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/ko/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/ko/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/ko/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/ko/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/ko/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/ko/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/ko/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/ko/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/ko/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/ko/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/ko/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/ko/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/ko/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/ko/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/ko/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/ko/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/ko/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/ko/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/ko/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/ko/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/ko/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/ko/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/ko/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/ko/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/ko/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/ko/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/ko/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/ko/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/ko/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/ko/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/ko/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/ko/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/ko/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/ko/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/ko/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/ko/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/ko/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/ko/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/ko/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/ko/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/ko/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/ko/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/ko/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/ko/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/ko/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/ko/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/ko/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/ko/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/ko/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/ko/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/ko/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/ko/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/ko/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/ko/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/ko/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/ko/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/ko/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/ko/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/ko/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/ko/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/ko/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/ko/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/ko/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/ko/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/ko/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/ko/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/ko/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/ko/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/ko/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/ko/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/ko/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/ko/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/ko/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/ko/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/ko/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/ko/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/ko/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/ko/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/ko/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/ko/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/ko/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/ko/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/ko/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/ko/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/ko/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/ko/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/ko/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/ko/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/ko/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/ko/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/ko/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/ko/docs/feature-guides/events): Track custom events on your website
    - [Globe](/ko/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/ko/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/ko/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/ko/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/ko/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/ko/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/ko/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/ko/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/ko/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/ko/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/ko/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/ko/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/ko/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/ko/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/ko/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/ko/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/ko/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/ko/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/ko/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/ko/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/ko/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/ko/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/ko/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/ko/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/ko/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/ko/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/ko/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/ko/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/ko/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/ko/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/ko/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/ko/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/ko/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/ko/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/ko/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/ko/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/ko/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/ko/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/ko/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/ko/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/ko/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/ko/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/ko/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/ko/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/ko/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/ko/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/ko/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/ko/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/ko/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/ko/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/ko/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/ko/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/ko/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/ko/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/ko/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/ko/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/ko/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/ko/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/ko/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/ko/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/ko/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/ko/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/ko/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/ko/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/ko/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/ko/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/ko/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/ko/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/ko/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/ko/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/ko/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/ko/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/ko/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/ko/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/ko/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/ko/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/ko/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/ko/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/ko/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/ko/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/ko/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/ko/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/ko/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/ko/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/ko/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/ko/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/ko/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/ko/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/ko/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/ko/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/ko/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/ko/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/ko/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/ko/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/ko/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/ko/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/ko/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/ko/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/ko/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/ko/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/ko/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/ko/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/ko/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/ko/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/ko/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/ko/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/ko/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/ko/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/ko/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/ko/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/ko/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/ko/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/pt/docs): Introduction to OnyxMetric
  - [Comparison](/pt/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/pt/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/pt/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/pt/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/pt/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/pt/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/pt/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/pt/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/pt/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/pt/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/pt/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/pt/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/pt/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/pt/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/pt/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/pt/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/pt/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/pt/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/pt/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/pt/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/pt/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/pt/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/pt/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/pt/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/pt/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/pt/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/pt/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/pt/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/pt/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/pt/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/pt/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/pt/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/pt/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/pt/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/pt/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/pt/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/pt/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/pt/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/pt/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/pt/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/pt/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/pt/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/pt/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/pt/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/pt/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/pt/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/pt/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/pt/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/pt/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/pt/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/pt/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/pt/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/pt/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/pt/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/pt/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/pt/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/pt/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/pt/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/pt/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/pt/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/pt/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/pt/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/pt/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/pt/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/pt/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/pt/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/pt/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/pt/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/pt/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/pt/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/pt/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/pt/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/pt/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/pt/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/pt/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/pt/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/pt/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/pt/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/pt/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/pt/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/pt/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/pt/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/pt/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/pt/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/pt/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/pt/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/pt/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/pt/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/pt/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/pt/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/pt/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/pt/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/pt/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/pt/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/pt/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/pt/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/pt/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/pt/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/pt/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/pt/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/pt/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/pt/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/pt/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/pt/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/pt/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/pt/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/pt/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/pt/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/pt/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/pt/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/pt/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/pt/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/pt/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/pt/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/pt/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/pt/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/pt/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/pt/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/pt/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/pt/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/pt/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/pt/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/pt/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/pt/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/pt/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/pt/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/pt/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/pt/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/pt/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/pt/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/pt/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/pt/docs/feature-guides/events): Track custom events on your website
    - [Globe](/pt/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/pt/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/pt/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/pt/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/pt/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/pt/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/pt/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/pt/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/pt/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/pt/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/pt/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/pt/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/pt/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/pt/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/pt/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/pt/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/pt/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/pt/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/pt/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/pt/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/pt/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/pt/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/pt/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/pt/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/pt/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/pt/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/pt/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/pt/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/pt/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/pt/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/pt/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/pt/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/pt/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/pt/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/pt/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/pt/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/pt/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/pt/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/pt/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/pt/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/pt/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/pt/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/pt/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/pt/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/pt/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/pt/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/pt/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/pt/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/pt/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/pt/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/pt/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/pt/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/pt/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/pt/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/pt/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/pt/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/pt/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/pt/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/pt/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/pt/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/pt/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/pt/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/pt/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/pt/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/pt/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/pt/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/pt/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/pt/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/pt/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/pt/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/pt/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/pt/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/pt/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/pt/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/pt/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/pt/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/pt/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/pt/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/pt/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/pt/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/pt/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/pt/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/pt/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/pt/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/pt/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/pt/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/pt/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/pt/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/pt/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/pt/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/pt/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/pt/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/pt/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/pt/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/pt/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/pt/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/pt/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/pt/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/pt/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/pt/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/pt/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/pt/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/pt/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/pt/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/pt/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/pt/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/pt/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/pt/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/pt/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/pt/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/pt/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/pt/docs/api/api-keys/delete): Revoke an API key by its id.

# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/ja/docs): Introduction to OnyxMetric
  - [Comparison](/ja/docs/comparison): Comparison of OnyxMetric with other analytics solutions

  - **Usage**
  - [Tracking script](/ja/docs/script): How to install and configure the OnyxMetric tracking script
  - [Troubleshooting](/ja/docs/script-troubleshooting): Common issues and solutions when the OnyxMetric tracking script isn't sending traffic
  - [Track Events](/ja/docs/track-events): How to track custom events with OnyxMetric
  - [Autocapture](/ja/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/ja/docs/identify-users): How to identify and track logged-in users with OnyxMetric
  - [Tagging](/ja/docs/tagging): How to use tags to label and segment analytics data in OnyxMetric
  - Integration Guides
    - [Integration guides](/ja/docs/guides): Step-by-step instructions for adding OnyxMetric to popular website platforms, frameworks, and CMSs

    - **JavaScript frameworks**
    - [Angular](/ja/docs/guides/angular): Add OnyxMetric analytics to your Angular app
    - [Astro](/ja/docs/guides/astro): Add OnyxMetric analytics to your Astro site
    - [Ember](/ja/docs/guides/ember): Add OnyxMetric analytics to your Ember app
    - [htmx](/ja/docs/guides/htmx): Add OnyxMetric analytics to your htmx app
    - [Preact](/ja/docs/guides/preact): Add OnyxMetric analytics to your Preact app
    - [Qwik](/ja/docs/guides/qwik): Add OnyxMetric analytics to your Qwik app
    - React
      - [Next.js](/ja/docs/guides/react/next-js): Add OnyxMetric analytics to your Next.js app
      - [React (Vite / CRA)](/ja/docs/guides/react/vite-cra): Add OnyxMetric analytics to your React app
      - [React Router](/ja/docs/guides/react/react-router): Add OnyxMetric analytics to your React Router app
      - [TanStack Start](/ja/docs/guides/react/tanstack-start): Add OnyxMetric analytics to your TanStack Start app
      - [Remix](/ja/docs/guides/react/remix): Add OnyxMetric analytics to your Remix app
      - [Gatsby](/ja/docs/guides/react/gatsby): Step-by-step guide to add OnyxMetric cookieless analytics to your Gatsby site and start tracking visitors
    - [SolidJS](/ja/docs/guides/solid): Add OnyxMetric analytics to your SolidJS app
    - Svelte
      - [SvelteKit](/ja/docs/guides/svelte/sveltekit): Add OnyxMetric analytics to your SvelteKit app
      - [Svelte (Vite / Client-Side)](/ja/docs/guides/svelte/vite): Add OnyxMetric analytics to your Svelte app
    - Vue
      - [Nuxt.js](/ja/docs/guides/vue/nuxt): Add OnyxMetric analytics to your Nuxt app
      - [Vue.js (Vite / Client-Side)](/ja/docs/guides/vue/vite): Add OnyxMetric analytics to your Vue app

    - **Static site generators**
    - [Eleventy](/ja/docs/guides/eleventy): Add OnyxMetric analytics to your Eleventy site
    - [Hexo](/ja/docs/guides/hexo): Add OnyxMetric analytics to your Hexo site
    - [Hugo](/ja/docs/guides/hugo): Add OnyxMetric analytics to your Hugo site
    - [Jekyll](/ja/docs/guides/jekyll): Add OnyxMetric analytics to your Jekyll site
    - [Zola](/ja/docs/guides/zola): Step-by-step guide to add OnyxMetric cookieless analytics to your Zola site and start tracking visitors

    - **Backend frameworks**
    - [ASP.NET Core](/ja/docs/guides/aspnet): Add OnyxMetric analytics to your ASP.NET Core app
    - [Blazor](/ja/docs/guides/blazor): Add OnyxMetric analytics to your Blazor app
    - [Django](/ja/docs/guides/django): Add OnyxMetric analytics to your Django app
    - [FastAPI](/ja/docs/guides/fastapi): Add OnyxMetric analytics to your FastAPI app
    - [Flask](/ja/docs/guides/flask): Add OnyxMetric analytics to your Flask app
    - [Laravel](/ja/docs/guides/laravel): Add OnyxMetric analytics to your Laravel app
    - [Phoenix](/ja/docs/guides/phoenix): Add OnyxMetric analytics to your Phoenix app
    - [Ruby on Rails](/ja/docs/guides/rails): Add OnyxMetric analytics to your Ruby on Rails app

    - **Documentation tools**
    - [Docusaurus](/ja/docs/guides/docusaurus): Add OnyxMetric analytics to your Docusaurus docs
    - [Fumadocs](/ja/docs/guides/fumadocs): Add OnyxMetric analytics to your Fumadocs docs
    - [GitBook](/ja/docs/guides/gitbook): Add OnyxMetric analytics to your GitBook docs
    - [Mintlify](/ja/docs/guides/mintlify): Add OnyxMetric analytics to your Mintlify docs
    - [MkDocs](/ja/docs/guides/mkdocs): Add OnyxMetric analytics to your MkDocs docs
    - [Nextra](/ja/docs/guides/nextra): Add OnyxMetric analytics to your Nextra docs
    - [Starlight](/ja/docs/guides/starlight): Add OnyxMetric analytics to your Starlight docs
    - [VitePress](/ja/docs/guides/vitepress): Add OnyxMetric analytics to your VitePress docs

    - **Content management systems**
    - [Contentful](/ja/docs/guides/contentful): Add OnyxMetric analytics to a site that uses Contentful
    - [Craft CMS](/ja/docs/guides/craft-cms): Add OnyxMetric analytics to your Craft CMS site
    - [Drupal](/ja/docs/guides/drupal): Step-by-step guide to add OnyxMetric cookieless analytics to your Drupal site and start tracking visitors
    - [Ghost](/ja/docs/guides/ghost): Add OnyxMetric analytics to your Ghost publication
    - [HubSpot](/ja/docs/guides/hubspot): Add OnyxMetric analytics to your HubSpot site
    - [Joomla](/ja/docs/guides/joomla): Step-by-step guide to add OnyxMetric cookieless analytics to your Joomla site and start tracking visitors
    - [Kirby](/ja/docs/guides/kirby): Add OnyxMetric analytics to your Kirby site
    - [Payload](/ja/docs/guides/payload): Add OnyxMetric analytics to your Payload site
    - [Sanity](/ja/docs/guides/sanity): Add OnyxMetric analytics to a site that uses Sanity
    - [Statamic](/ja/docs/guides/statamic): Add OnyxMetric analytics to your Statamic site
    - [Storyblok](/ja/docs/guides/storyblok): Add OnyxMetric analytics to a site that uses Storyblok
    - [Strapi](/ja/docs/guides/strapi): Add OnyxMetric analytics to a site that uses Strapi
    - [TYPO3](/ja/docs/guides/typo3): Add OnyxMetric analytics to your TYPO3 site
    - [Umbraco](/ja/docs/guides/umbraco): Add OnyxMetric analytics to your Umbraco site
    - [WordPress](/ja/docs/guides/wordpress): Add OnyxMetric analytics to your WordPress site

    - **Website builders**
    - [Bubble](/ja/docs/guides/bubble): Add OnyxMetric analytics to your Bubble app
    - [Carrd](/ja/docs/guides/carrd): Add OnyxMetric analytics to your Carrd site
    - [Duda](/ja/docs/guides/duda): Add OnyxMetric analytics to your Duda site
    - [Framer](/ja/docs/guides/framer): Add OnyxMetric analytics to your Framer site
    - [Hostinger Website Builder](/ja/docs/guides/hostinger): Add OnyxMetric analytics to your Hostinger Website Builder site
    - [Squarespace](/ja/docs/guides/squarespace): Add OnyxMetric analytics to your Squarespace site
    - [Webflow](/ja/docs/guides/webflow): Add OnyxMetric analytics to your Webflow site
    - [Weebly](/ja/docs/guides/weebly): Add OnyxMetric analytics to your Weebly site
    - [Wix](/ja/docs/guides/wix): Add OnyxMetric analytics to your Wix site

    - **AI app builders**
    - [Bolt](/ja/docs/guides/bolt): Step-by-step guide to add OnyxMetric cookieless analytics to your Bolt app and start tracking visitors
    - [Lovable](/ja/docs/guides/lovable): Add OnyxMetric analytics to your Lovable app
    - [Replit](/ja/docs/guides/replit): Add OnyxMetric analytics to your Replit app
    - [v0](/ja/docs/guides/v0): Add OnyxMetric analytics to your v0 app

    - **E-commerce**
    - [BigCommerce](/ja/docs/guides/bigcommerce): Add OnyxMetric analytics to your BigCommerce store
    - [Ecwid](/ja/docs/guides/ecwid): Add OnyxMetric analytics to your Ecwid store
    - [Magento](/ja/docs/guides/magento): Add OnyxMetric analytics to your Magento store
    - [PrestaShop](/ja/docs/guides/prestashop): Add OnyxMetric analytics to your PrestaShop store
    - [Shopify](/ja/docs/guides/shopify): Step-by-step guide to add OnyxMetric cookieless analytics to your Shopify store and start tracking visitors
    - [Shopify Hydrogen](/ja/docs/guides/shopify-hydrogen): Add OnyxMetric analytics to your Shopify Hydrogen storefront
    - [ThriveCart](/ja/docs/guides/thrivecart): Add OnyxMetric analytics to your ThriveCart checkout pages
    - [WooCommerce](/ja/docs/guides/woocommerce): Add OnyxMetric analytics to your WooCommerce store

    - **Courses & communities**
    - [Circle](/ja/docs/guides/circle): Add OnyxMetric analytics to your Circle community
    - [Kajabi](/ja/docs/guides/kajabi): Add OnyxMetric analytics to your Kajabi site
    - [Podia](/ja/docs/guides/podia): Add OnyxMetric analytics to your Podia site
    - [Teachable](/ja/docs/guides/teachable): Add OnyxMetric analytics to your Teachable school
    - [Thinkific](/ja/docs/guides/thinkific): Add OnyxMetric analytics to your Thinkific site

    - **Landing pages & funnels**
    - [ClickFunnels](/ja/docs/guides/clickfunnels): Add OnyxMetric analytics to your ClickFunnels funnels
    - [Instapage](/ja/docs/guides/instapage): Add OnyxMetric analytics to your Instapage landing pages
    - [Leadpages](/ja/docs/guides/leadpages): Add OnyxMetric analytics to your Leadpages landing pages
    - [systeme.io](/ja/docs/guides/systeme-io): Add OnyxMetric analytics to your systeme.io funnels
    - [Unbounce](/ja/docs/guides/unbounce): Add OnyxMetric analytics to your Unbounce landing pages

    - **Tag managers**
    - [Google Tag Manager](/ja/docs/guides/google-tag-manager): Add OnyxMetric analytics through a Google Tag Manager container

    - **Desktop, mobile & extensions**
    - [Capacitor](/ja/docs/guides/capacitor): Add OnyxMetric analytics to your Capacitor app
    - [Electron](/ja/docs/guides/electron): Add OnyxMetric analytics to your Electron app
    - [Flutter web](/ja/docs/guides/flutter-web): Add OnyxMetric analytics to your Flutter web app
    - [Tauri](/ja/docs/guides/tauri): Add OnyxMetric analytics to your Tauri app

    - **Other platforms**
    - [Discourse](/ja/docs/guides/discourse): Add OnyxMetric analytics to your Discourse forum
    - [Moodle](/ja/docs/guides/moodle): Add OnyxMetric analytics to your Moodle site
    - [Odoo](/ja/docs/guides/odoo): Step-by-step guide to add OnyxMetric cookieless analytics to your Odoo website and start tracking visitors
  - Proxy Guide
    - [Proxy Setup Guide](/ja/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying OnyxMetric through your own domain
    - [Generic Proxy Setup](/ja/docs/proxy-guide/get-started): Framework-agnostic guide to proxy OnyxMetric tracking through your own domain

    - **Frameworks**
    - [Next.js Proxy Setup](/ja/docs/proxy-guide/next-js): Configure Next.js rewrites to proxy OnyxMetric tracking and bypass ad blockers
    - [Nginx Proxy Setup](/ja/docs/proxy-guide/nginx): Configure Nginx reverse proxy to serve OnyxMetric tracking and bypass ad blockers
    - [Caddy Proxy Setup](/ja/docs/proxy-guide/caddy): Configure Caddy reverse proxy to serve OnyxMetric tracking with automatic HTTPS
    - [Vercel Proxy Setup](/ja/docs/proxy-guide/vercel): Deploy OnyxMetric proxy on Vercel with Edge Network caching
    - [Express.js Proxy Setup](/ja/docs/proxy-guide/express): Configure Express.js middleware to proxy OnyxMetric tracking requests
    - [Laravel Proxy Setup](/ja/docs/proxy-guide/laravel): Configure Laravel routes and middleware to proxy OnyxMetric tracking
    - [Astro Proxy Setup](/ja/docs/proxy-guide/astro): Configure Astro middleware to proxy OnyxMetric tracking requests
    - [Cloudflare Workers Proxy Setup](/ja/docs/proxy-guide/cloudflare-workers): Use Cloudflare Workers to proxy OnyxMetric tracking at the edge

    - **Help**
    - [Troubleshooting Proxy Setup](/ja/docs/proxy-guide/troubleshooting): Common issues and solutions for OnyxMetric proxy configurations
  - SDKs
    - [JavaScript (Web)](/ja/docs/sdks/web): Official JavaScript SDK for OnyxMetric Analytics
    - [React Native](/ja/docs/sdks/react-native): Official React Native SDK for OnyxMetric Analytics
    - [JavaScript (Node.js)](/ja/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - MCP
    - [MCP](/ja/docs/mcp): Let an AI assistant explore and manage your OnyxMetric analytics through the hosted Model Context Protocol server
    - [Claude Code](/ja/docs/mcp/claude-code): Connect Claude Code to OnyxMetric's MCP server with OAuth or an API key
    - [Codex](/ja/docs/mcp/codex): Connect the Codex CLI to OnyxMetric's MCP server with OAuth or an API key
    - [Claude Desktop](/ja/docs/mcp/claude-desktop): Add OnyxMetric as a custom connector on claude.ai, Claude Desktop, and mobile
    - [Cursor](/ja/docs/mcp/cursor): Connect Cursor to OnyxMetric's MCP server with an API key
    - [VS Code](/ja/docs/mcp/vscode): Connect VS Code and Copilot agent mode to OnyxMetric's MCP server
    - [opencode](/ja/docs/mcp/opencode): Connect opencode to OnyxMetric's MCP server with OAuth or an API key
  - [Hiding your own traffic](/ja/docs/hiding-own-traffic): Prevent your own visits from being tracked in analytics
  - [Filter traffic](/ja/docs/filter-traffic): Exclude traffic by IP address, country, path, hostname, or user agent
  - [Bot detection](/ja/docs/bot-detection): How OnyxMetric identifies and filters bot traffic from your analytics
  - [Segments](/ja/docs/segments): Save a set of filters as a named segment and apply it to any report with one click
  - [Goals](/ja/docs/goals): Track conversions from page visits, custom events, and autocaptured interactions
  - [Funnels](/ja/docs/funnels): Analyze conversion through multi-step user journeys
  - [Webhooks](/ja/docs/webhooks): Get a signed HTTPS POST the moment a goal converts or a custom event is tracked
  - Embeds
    - [Widget Embeds](/ja/docs/embeds/widget): Embed a compact live visitor widget on your own site
    - [Dashboard Embed](/ja/docs/embeds/dashboard): Embed your analytics dashboard on another site
  - Feature Guides
    - [Errors](/ja/docs/feature-guides/errors): Track JavaScript errors on your website and review them in OnyxMetric next to your analytics
    - [Events](/ja/docs/feature-guides/events): Track custom events on your website
    - [Globe](/ja/docs/feature-guides/globe): Visualize geographic traffic distribution
    - [User Journeys](/ja/docs/feature-guides/journeys): Visualize how users navigate your site
    - [Performance](/ja/docs/feature-guides/performance): Track Core Web Vitals and site speed
    - [Session Replay](/ja/docs/feature-guides/session-replay): Watch recordings of user sessions
    - [Retention](/ja/docs/feature-guides/retention): Measure how many users return over time
    - [Sessions](/ja/docs/feature-guides/sessions): Analyze individual user sessions
    - [Users](/ja/docs/feature-guides/users): Analyze individual users across sessions

  - **Settings**
  - [Account settings](/ja/docs/account-settings): Manage your personal account settings including profile, security, and API keys
  - [Organization settings](/ja/docs/organization-settings): Manage your organization, team members, roles, and permissions
  - [Teams](/ja/docs/teams): Organize sites into teams to control which members can access them
  - [Billing](/ja/docs/billing-settings): Manage your subscription, billing, and usage for OnyxMetric Cloud
  - [Inviting users](/ja/docs/inviting-users): Invite team members to your OnyxMetric organization and control their access to specific sites
  - [Site settings](/ja/docs/site-settings): Configure your site settings including privacy options, analytics features, traffic filtering, and more
  - [Data Import](/ja/docs/data-import): Import historical analytics data from other platforms

  - **Other**
  - [Definitions](/ja/docs/definitions): Understanding OnyxMetric's metrics and data points
- API Reference: REST API endpoints and authentication
  - [Getting Started](/ja/docs/api/getting-started): Authentication, common parameters, and best practices for the OnyxMetric Stats API

  - **Guides**
  - [Automated Weekly Report](/ja/docs/api/weekly-report): Combine the overview and metric endpoints into a scheduled digest that summarizes last week's traffic, the week-over-week change, and your top pages and traffic sources.
  - [Find Where Users Drop Off](/ja/docs/api/funnel-dropoff): Chain the funnel analysis and journeys endpoints to locate the biggest leak in a conversion flow, then discover where the users who abandon actually go instead.
  - [Compare Channel Performance](/ja/docs/api/channel-performance): Rank your acquisition channels by how well they convert — not just how much traffic they send — by combining the metric, overview, and goals endpoints with channel filters.
  - [Build a Live Visitor Feed](/ja/docs/api/live-feed): Poll the live visitor count and the events endpoint to build a real-time activity stream — the foundation for a live dashboard, an internal "who's online" widget, or an alert when a key page gets traffic.

  - **Endpoints**
  - [Sending Events](/ja/docs/api/sending-events): Track pageviews, custom events, performance, and errors from any platform using the HTTP API.
  - Overview
    - [Get Overview](/ja/docs/api/overview/overview): Returns high-level analytics metrics for a site.
    - [Get Overview (Time Series)](/ja/docs/api/overview/time-series): Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
    - [Get Metric](/ja/docs/api/overview/metric): Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
    - [Get Page Titles](/ja/docs/api/overview/page-titles): Returns page-view metrics aggregated by HTML page title.
    - [Get Live Visitors](/ja/docs/api/overview/live-visitors): Returns the count of unique active visitors within the specified time window. Useful for displaying real-time visitor counts.
  - Sessions
    - [Get Sessions](/ja/docs/api/sessions/list): Returns a paginated list of sessions with their analytics data.
    - [Get Session](/ja/docs/api/sessions/get): Returns detailed information about a specific session including all events and pageviews.
    - [Get Session Locations](/ja/docs/api/sessions/locations): Returns aggregated session locations with coordinates for map visualization.
  - Session Replay
    - [Get Session Replays](/ja/docs/api/session-replay/list): Returns recorded session replays with metadata, newest first.
    - [Get Session Replay Events](/ja/docs/api/session-replay/events): Returns the rrweb events and metadata needed to reconstruct a session replay.
    - [Delete Session Replay](/ja/docs/api/session-replay/delete): Permanently deletes a session replay recording. Requires the editor role or above on the site.
  - Users
    - [Get Users](/ja/docs/api/users/list): Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
    - [Get User Session Count](/ja/docs/api/users/session-count): Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
    - [Get User Info](/ja/docs/api/users/info): Returns detailed information about a specific user, including their profile traits and linked devices.
  - User Traits
    - [Get User Trait Keys](/ja/docs/api/user-traits/keys): Returns the known user trait keys with the number of users that have each.
    - [Get User Trait Values](/ja/docs/api/user-traits/values): Returns the distinct values for a given trait key, with user counts.
    - [Get Users by Trait](/ja/docs/api/user-traits/users): Returns users matching a specific trait key and value, with location and session metadata.
  - Events
    - [Get Events](/ja/docs/api/events/list): Returns a paginated list of events (pageviews, custom events, and outbound clicks).
    - [Get Event](/ja/docs/api/events/get): Reads the server-side enrichment of one tracked event by its event_id, within milliseconds of tracking.
    - [Get Event Names](/ja/docs/api/events/names): Returns a list of unique custom event names with their occurrence counts.
    - [Get Event Time Series](/ja/docs/api/events/time-series): Returns time-bucketed counts for the top custom events.
    - [Get Event Counts](/ja/docs/api/events/count): Returns time-bucketed event counts grouped by event type.
    - [Get Event Properties](/ja/docs/api/events/properties): Returns property key-value pairs for a specific event name with their occurrence counts.
    - [Get Outbound Links](/ja/docs/api/events/outbound): Returns a list of outbound link clicks with their occurrence counts.
  - Goals
    - [Get Goals](/ja/docs/api/goals/list): Returns a paginated list of goals with their conversion metrics.
    - [Get Goal Time Series](/ja/docs/api/goals/time-series): Returns goal conversions and conversion rate over time.
    - [Get Goal Sessions](/ja/docs/api/goals/sessions): Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
    - [Create Goal](/ja/docs/api/goals/create): Creates a new goal for tracking conversions.
    - [Update Goal](/ja/docs/api/goals/update): Updates an existing goal.
    - [Delete Goal](/ja/docs/api/goals/delete): Permanently deletes a goal from a site by its ID. This action cannot be undone, and the goal stops counting conversions.
  - Annotations
    - [Get Annotations](/ja/docs/api/annotations/list): Returns the timeline annotations that apply to a site, including organization-wide ones.
    - [Create Annotation](/ja/docs/api/annotations/create): Pins a note to a date or date range on the site's traffic chart.
    - [Update Annotation](/ja/docs/api/annotations/update): Updates an annotation's fields.
    - [Delete Annotation](/ja/docs/api/annotations/delete): Permanently deletes an annotation.
  - Funnels
    - [Get Funnels](/ja/docs/api/funnels/list): Returns all saved funnels for a site.
    - [Analyze Funnel](/ja/docs/api/funnels/analyze): Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
    - [Get Funnel Step Sessions](/ja/docs/api/funnels/step-sessions): Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
    - [Create Funnel](/ja/docs/api/funnels/create): Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
    - [Delete Funnel](/ja/docs/api/funnels/delete): Deletes a saved funnel. This action cannot be undone.
  - Segments
    - [Get Segments](/ja/docs/api/segments/list): Returns the saved segments available on a site: its own plus organization-wide ones. Callers without site access only see segments shown on the public dashboard.
    - [Get Segment](/ja/docs/api/segments/get): Returns one saved segment.
    - [Create Segment](/ja/docs/api/segments/create): Creates a saved segment. Members create site segments they own; editors, admins, and owners can also create organization-wide segments.
    - [Update Segment](/ja/docs/api/segments/update): Updates a saved segment. Editors, admins, and owners can edit any segment; members can edit segments they created. Only the fields you send change.
    - [Delete Segment](/ja/docs/api/segments/delete): Deletes a saved segment. Editors, admins, and owners can delete any segment; members can delete segments they created. Links that already expanded the segment's filters keep working.
  - Performance
    - [Get Performance Overview](/ja/docs/api/performance/overview): Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
    - [Get Performance Time Series](/ja/docs/api/performance/time-series): Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
    - [Get Performance by Dimension](/ja/docs/api/performance/by-dimension): Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
  - Errors
    - [Get Error Names](/ja/docs/api/errors/names): Returns a list of unique error messages with occurrence counts and affected session counts.
    - [Get Error Events](/ja/docs/api/errors/events): Returns individual error occurrences for a specific error message, with full context including stack traces.
    - [Get Error Time Series](/ja/docs/api/errors/time-series): Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
  - Bots
    - [Get Bot Overview](/ja/docs/api/bots/overview): Returns aggregate bot-traffic metrics with a breakdown by detection layer.
    - [Get Bot Time Series](/ja/docs/api/bots/time-series): Returns bot request counts over time.
    - [Get Bots by Dimension](/ja/docs/api/bots/by-dimension): Returns bot requests broken down by a dimension.
    - [Get AI Summary](/ja/docs/api/bots/ai-summary): Returns crawls and referrals per AI operator, side by side.
  - Insights
    - [Get Retention](/ja/docs/api/insights/retention): Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
    - [Get Journeys](/ja/docs/api/insights/journeys): Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.

  - **Management**
  - Organizations
    - [Get My Organizations](/ja/docs/api/organizations/list): Returns all organizations the authenticated user is a member of, including all members for each organization. Excludes subscription and billing information. Supports both session cookies and API key (Bearer token) authentication.
    - [Get Organization Sites](/ja/docs/api/organizations/sites): Returns all sites in an organization the caller can access, with usage and subscription info.
    - [Create Site](/ja/docs/api/organizations/create-site): Creates a new site within an organization. Requires admin or owner role in the organization.
    - [Get Organization Members](/ja/docs/api/organizations/members): Returns all members of an organization with their user details and roles. Requires membership in the organization.
    - [Add Organization Member](/ja/docs/api/organizations/add-member): Adds an existing user to an organization with a role. Requires admin or owner role, and you cannot assign a role above your own.
    - [Invite Member](/ja/docs/api/organizations/invite-member): Send an organization invitation to a user by email.
    - [Remove Member](/ja/docs/api/organizations/remove-member): Remove a member from an OnyxMetric organization with a POST request to the API.
    - [Update Member Role](/ja/docs/api/organizations/update-member-role): Change an organization member's role.
    - [Get Organization Event Count](/ja/docs/api/organizations/event-count): Returns daily event usage counts across an organization's sites.
  - Teams
    - [Get Teams](/ja/docs/api/teams/list): Returns the teams in an organization, with their members and accessible sites.
    - [Create Team](/ja/docs/api/teams/create): Creates a team in an organization. Requires admin/owner role.
    - [Update Team](/ja/docs/api/teams/update): Updates a team's name, members, or site access. Requires admin/owner role.
    - [Delete Team](/ja/docs/api/teams/delete): Deletes a team. Requires admin/owner role.
  - Sites
    - [Get Site](/ja/docs/api/sites/get): Returns detailed information about a specific site including its configuration.
    - [Get Site Has Data](/ja/docs/api/sites/has-data): Returns whether the site has received any analytics events.
    - [Get Site Public Status](/ja/docs/api/sites/is-public): Returns whether the site's analytics are publicly accessible.
    - [Delete Site](/ja/docs/api/sites/delete): Permanently deletes a site and all its associated data. This action cannot be undone. Requires admin or owner role.
    - [Update Site Config](/ja/docs/api/sites/update-config): Updates site configuration settings. All fields are optional - only include the fields you want to update. Requires the editor role or above on the site.
    - [Get Excluded IPs](/ja/docs/api/sites/excluded-ips): Returns the list of IP addresses and CIDR ranges that are excluded from tracking.
    - [Get Excluded Countries](/ja/docs/api/sites/excluded-countries): Returns the list of country codes that are excluded from tracking.
    - [Get Excluded Paths](/ja/docs/api/sites/excluded-paths): Returns the list of URL paths excluded from analytics.
    - [Get Excluded Hostnames](/ja/docs/api/sites/excluded-hostnames): Returns the list of hostnames excluded from analytics.
    - [Get Excluded User Agents](/ja/docs/api/sites/excluded-user-agents): Returns the list of user-agent patterns excluded from analytics.
    - [Get Private Link Config](/ja/docs/api/sites/get-private-link): Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.
    - [Update Private Link Config](/ja/docs/api/sites/update-private-link): Generates or revokes a private link key for sharing analytics without authentication. Requires the editor role or above on the site.
    - [Export PDF Report](/ja/docs/api/sites/export-pdf): Generates a downloadable PDF analytics report for a date range.
  - Imports
    - [List Imports](/ja/docs/api/imports/list): Returns all data imports for a site with their progress counts.
    - [Create Import](/ja/docs/api/imports/create): Starts a new data import from a supported platform.
    - [Upload Import Events](/ja/docs/api/imports/events): Uploads a batch of raw events to an in-progress import.
    - [Delete Import](/ja/docs/api/imports/delete): Deletes an import and all events it added. The import must be finished.
  - API Keys
    - [Create API Key](/ja/docs/api/api-keys/create): Programmatically create a new API key for your account.
    - [Create Organization API Key](/ja/docs/api/api-keys/create-org): Programmatically create an API key owned by an organization.
    - [List API Keys](/ja/docs/api/api-keys/list): List the API keys for your account or organization.
    - [Update API Key](/ja/docs/api/api-keys/update): Update an existing API key's name, enabled state, or expiry.
    - [Delete API Key](/ja/docs/api/api-keys/delete): Revoke an API key by its id.