# Docs

- Documentation: Guides, setup, and feature documentation
  - [Introduction](/docs): Introduction to Rybbit
  - [Comparison](/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/docs/track-events): How to track custom events with Rybbit
  - [Autocapture](/docs/autocapture): Automatically track user interactions without writing code
  - [Identify Users](/docs/identify-users): How to identify and track logged-in users with Rybbit
  - [Tagging](/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/de/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/de/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/de/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/de/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/de/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/de/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/de/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/de/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/de/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/de/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/de/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/de/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/de/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/de/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/de/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/de/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/de/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/de/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/de/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/de/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/de/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/de/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/de/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/de/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/de/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/de/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/de/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/de/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/de/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/de/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/de/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/de/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/de/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/de/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/de/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/de/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/de/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/de/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/de/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/de/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/de/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/de/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/de/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/de/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/de/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/de/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/de/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/de/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/de/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/de/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/de/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/de/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/de/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/de/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/de/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/de/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/de/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/de/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/de/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/de/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/de/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/fr/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/fr/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/fr/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/fr/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/fr/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/fr/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/fr/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/fr/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/fr/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/fr/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/fr/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/fr/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/fr/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/fr/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/fr/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/fr/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/fr/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/fr/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/fr/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/fr/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/fr/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/fr/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/fr/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/fr/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/fr/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/fr/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/fr/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/fr/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/fr/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/fr/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/fr/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/fr/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/fr/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/fr/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/fr/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/fr/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/fr/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/fr/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/fr/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/fr/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/fr/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/fr/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/fr/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/fr/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/fr/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/fr/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/fr/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/fr/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/fr/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/fr/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/fr/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/fr/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/fr/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/fr/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/fr/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/fr/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/fr/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/fr/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/fr/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/fr/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/fr/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/zh/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/zh/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/zh/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/zh/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/zh/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/zh/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/zh/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/zh/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/zh/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/zh/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/zh/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/zh/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/zh/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/zh/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/zh/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/zh/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/zh/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/zh/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/zh/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/zh/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/zh/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/zh/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/zh/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/zh/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/zh/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/zh/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/zh/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/zh/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/zh/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/zh/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/zh/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/zh/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/zh/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/zh/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/zh/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/zh/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/zh/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/zh/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/zh/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/zh/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/zh/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/zh/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/zh/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/zh/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/zh/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/zh/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/zh/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/zh/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/zh/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/zh/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/zh/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/zh/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/zh/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/zh/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/zh/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/zh/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/zh/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/zh/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/zh/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/zh/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/zh/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/es/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/es/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/es/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/es/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/es/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/es/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/es/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/es/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/es/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/es/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/es/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/es/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/es/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/es/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/es/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/es/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/es/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/es/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/es/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/es/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/es/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/es/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/es/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/es/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/es/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/es/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/es/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/es/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/es/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/es/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/es/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/es/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/es/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/es/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/es/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/es/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/es/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/es/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/es/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/es/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/es/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/es/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/es/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/es/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/es/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/es/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/es/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/es/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/es/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/es/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/es/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/es/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/es/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/es/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/es/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/es/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/es/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/es/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/es/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/es/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/es/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/pl/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/pl/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/pl/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/pl/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/pl/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/pl/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/pl/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/pl/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/pl/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/pl/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/pl/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/pl/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/pl/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/pl/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/pl/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/pl/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/pl/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/pl/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/pl/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/pl/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/pl/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/pl/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/pl/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/pl/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/pl/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/pl/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/pl/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/pl/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/pl/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/pl/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/pl/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/pl/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/pl/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/pl/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/pl/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/pl/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/pl/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/pl/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/pl/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/pl/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/pl/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/pl/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/pl/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/pl/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/pl/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/pl/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/pl/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/pl/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/pl/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/pl/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/pl/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/pl/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/pl/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/pl/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/pl/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/pl/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/pl/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/pl/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/pl/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/pl/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/pl/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/it/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/it/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/it/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/it/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/it/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/it/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/it/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/it/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/it/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/it/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/it/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/it/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/it/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/it/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/it/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/it/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/it/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/it/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/it/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/it/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/it/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/it/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/it/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/it/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/it/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/it/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/it/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/it/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/it/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/it/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/it/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/it/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/it/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/it/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/it/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/it/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/it/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/it/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/it/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/it/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/it/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/it/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/it/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/it/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/it/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/it/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/it/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/it/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/it/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/it/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/it/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/it/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/it/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/it/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/it/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/it/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/it/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/it/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/it/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/it/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/it/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/ko/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/ko/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/ko/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/ko/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/ko/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/ko/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/ko/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/ko/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/ko/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/ko/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/ko/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/ko/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/ko/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/ko/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/ko/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/ko/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/ko/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/ko/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/ko/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/ko/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/ko/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/ko/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/ko/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/ko/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/ko/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/ko/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/ko/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/ko/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/ko/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/ko/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/ko/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/ko/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/ko/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/ko/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/ko/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/ko/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/ko/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/ko/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/ko/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/ko/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/ko/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/ko/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/ko/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/ko/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/ko/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/ko/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/ko/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/ko/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/ko/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/ko/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/ko/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/ko/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/ko/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/ko/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/ko/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/ko/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/ko/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/ko/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/ko/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/ko/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/ko/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/pt/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/pt/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/pt/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/pt/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/pt/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/pt/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/pt/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/pt/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/pt/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/pt/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/pt/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/pt/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/pt/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/pt/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/pt/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/pt/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/pt/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/pt/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/pt/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/pt/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/pt/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/pt/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/pt/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/pt/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/pt/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/pt/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/pt/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/pt/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/pt/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/pt/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/pt/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/pt/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/pt/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/pt/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/pt/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/pt/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/pt/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/pt/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/pt/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/pt/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/pt/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/pt/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/pt/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/pt/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/pt/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/pt/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/pt/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/pt/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/pt/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/pt/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/pt/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/pt/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/pt/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/pt/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/pt/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/pt/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/pt/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/pt/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/pt/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/pt/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/pt/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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 Rybbit
  - [Comparison](/ja/docs/comparison): Comparison of Rybbit with other analytics solutions
  - [Architecture](/ja/docs/architecture): Understanding Rybbit's architecture
  - [Self-hosted vs Cloud](/ja/docs/self-host-vs-cloud): Compare self-hosted and cloud versions of Rybbit

  - **Usage**
  - [Tracking script](/ja/docs/script): How to install and configure the Rybbit tracking script
  - [Troubleshooting](/ja/docs/script-troubleshooting): Common issues and solutions when the Rybbit tracking script isn't sending traffic
  - [Track Events](/ja/docs/track-events): How to track custom events with Rybbit
  - [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 Rybbit
  - [Tagging](/ja/docs/tagging): How to use tags to label and segment analytics data in Rybbit
  - Integration Guides
    - [Angular](/ja/docs/guides/angular): Integrate Rybbit Analytics with your Angular application
    - [Astro](/ja/docs/guides/astro): Integrate Rybbit Analytics with your Astro application for content-rich websites
    - [BigCommerce](/ja/docs/guides/bigcommerce): Integrate Rybbit Analytics with your BigCommerce store
    - [Bubble.io](/ja/docs/guides/bubble): Integrate Rybbit Analytics with your Bubble.io application to track user behavior
    - [Carrd](/ja/docs/guides/carrd): Integrate Rybbit Analytics with your Carrd site
    - [Contentful](/ja/docs/guides/contentful): Integrate Rybbit Analytics with your Contentful-powered website
    - [Docusaurus](/ja/docs/guides/docusaurus): Integrate Rybbit Analytics with your Docusaurus v2+ website
    - [Drupal](/ja/docs/guides/drupal): Integrate Rybbit Analytics with your Drupal site using the rybbit module
    - [Framer](/ja/docs/guides/framer): Integrate Rybbit Analytics with your Framer site for behavior tracking and custom events
    - [Ghost](/ja/docs/guides/ghost): Integrate Rybbit Analytics with your Ghost blog or publication
    - [GitBook](/ja/docs/guides/gitbook): Integrate Rybbit Analytics with your GitBook documentation
    - [Google Tag Manager](/ja/docs/guides/google-tag-manager): Integrate Rybbit Analytics with your website using Google Tag Manager
    - [Hugo](/ja/docs/guides/hugo): Integrate Rybbit Analytics with your Hugo static site using partial templates
    - [Jekyll](/ja/docs/guides/jekyll): Integrate Rybbit Analytics with your Jekyll static site using layout files or includes
    - [Joomla](/ja/docs/guides/joomla): Integrate Rybbit Analytics with your Joomla website
    - [Laravel](/ja/docs/guides/laravel): Integrate Rybbit Analytics with your Laravel application using Blade templates
    - [Mintlify](/ja/docs/guides/mintlify): Integrate Rybbit Analytics with your Mintlify documentation site
    - [PrestaShop](/ja/docs/guides/prestashop): Integrate Rybbit Analytics with your PrestaShop store
    - React
      - [Next.js](/ja/docs/guides/react/next-js): Integrate Rybbit with your Next.js application for analytics tracking
      - [React (Vite / CRA)](/ja/docs/guides/react/vite-cra): Integrate Rybbit with your client-side React application
      - [Gatsby](/ja/docs/guides/react/gatsby): Integrate Rybbit with your Gatsby site for analytics tracking
      - [Remix](/ja/docs/guides/react/remix): Integrate Rybbit with your Remix application for analytics tracking
    - [Sanity](/ja/docs/guides/sanity): Integrate Rybbit Analytics with your Sanity-powered website
    - [Shopify](/ja/docs/guides/shopify): Integrate Rybbit with your Shopify store to capture events, track conversions, and analyze user behavior.
    - [Squarespace](/ja/docs/guides/squarespace): Integrate Rybbit Analytics with your Squarespace website using the Code Injection feature.
    - [Strapi](/ja/docs/guides/strapi): Integrate Rybbit Analytics with your Strapi-powered website
    - Svelte
      - [Svelte (Vite / Client-Side)](/ja/docs/guides/svelte/vite): Integrate Rybbit with your client-side Svelte application
      - [SvelteKit](/ja/docs/guides/svelte/sveltekit): Integrate Rybbit with your SvelteKit application for analytics tracking
    - [ThriveCart](/ja/docs/guides/thrivecart): Integrate Rybbit Analytics with your ThriveCart checkout pages
    - [VitePress](/ja/docs/guides/vitepress): Integrate Rybbit Analytics with your VitePress documentation site
    - Vue
      - [Vue.js (Vite / Client-Side)](/ja/docs/guides/vue/vite): Integrate Rybbit with your client-side Vue.js application
      - [Nuxt.js](/ja/docs/guides/vue/nuxt): Integrate Rybbit with your Nuxt.js application for analytics tracking
    - [Webflow](/ja/docs/guides/webflow): Enable analytics, custom events, and more on your Webflow site with Rybbit.
    - [Wix](/ja/docs/guides/wix): Integrate Rybbit Analytics with your Wix website using custom code snippets.
    - [WooCommerce](/ja/docs/guides/woocommerce): Integrate Rybbit Analytics with your WooCommerce store
    - [WordPress](/ja/docs/guides/wordpress): Integrate Rybbit Analytics with your WordPress site
  - Proxy Guide
    - [Proxy Setup Guide](/ja/docs/proxy-guide): Bypass ad blockers and improve tracking accuracy by proxying Rybbit through your own domain
    - [Generic Proxy Setup](/ja/docs/proxy-guide/get-started): Framework-agnostic guide to proxy Rybbit tracking through your own domain

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

    - **Help**
    - [Troubleshooting Proxy Setup](/ja/docs/proxy-guide/troubleshooting): Common issues and solutions for Rybbit proxy configurations
  - SDKs
    - [JavaScript (Web)](/ja/docs/sdks/web): Official JavaScript SDK for Rybbit Analytics
    - [React Native](/ja/docs/sdks/react-native): Official React Native SDK for Rybbit Analytics
    - [JavaScript (Node.js)](/ja/docs/sdks/node): Server-side analytics tracking for Node.js applications
  - [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 Rybbit identifies and filters bot traffic from your analytics
  - [Goals](/ja/docs/goals): Track conversions by monitoring page visits and custom events
  - [Funnels](/ja/docs/funnels): Analyze conversion through multi-step user journeys
  - 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
    - [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

  - **Self-hosting**
  - [Quick start](/ja/docs/self-hosting): Set up your own instance of Rybbit using our setup script
  - [Managing your installation](/ja/docs/managing-your-installation): Managing your Rybbit installation
  - [Troubleshooting](/ja/docs/troubleshooting): Docker cleanup and troubleshooting guide for Rybbit
  - Self-Hosting Guides
    - [Custom Nginx setup](/ja/docs/self-hosting-guides/custom-nginx): Set up Rybbit with your own Nginx installation instead of using the built-in Caddy server
    - [Nginx Proxy Manager (NPM) setup](/ja/docs/self-hosting-guides/nginx-proxy-manager): Set up Rybbit with Nginx Proxy Manager without exposing ports directly to the host
    - [Advanced self-hosting](/ja/docs/self-hosting-guides/self-hosting-advanced): Advanced configuration options for self-hosting Rybbit
    - [Manual Docker Compose setup](/ja/docs/self-hosting-guides/self-hosting-manual): Manual setup guide for Rybbit using Docker Compose without the setup script
    - [Pangolin setup](/ja/docs/self-hosting-guides/pangolin): Set up Rybbit with Pangolin as a self-hosted reverse proxy using Newt
  - [Migration to v1.0](/ja/docs/v1-migration): Breaking changes and migration steps when upgrading to Rybbit v1.0

  - **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 Rybbit Cloud
  - [Inviting users](/ja/docs/inviting-users): Invite team members to your Rybbit 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 Rybbit'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 Rybbit 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 sessions 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 site write access.
  - 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 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): Deletes a goal. This action cannot be undone.
  - 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.
  - 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.
  - 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 a user to an organization with a specified role. The user must already exist in the system. Requires admin or owner role in the organization.
    - [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 organization.
    - [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 admin or owner role.
    - [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 admin or owner role.
    - [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.
    - [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.