# OpenRevenue Documentation > Guides and API reference for OpenRevenue, the revenue-first, privacy-friendly web analytics platform. - [Welcome to OpenRevenue](https://www.openrevenue.com/docs/index.md): Learn what OpenRevenue is, how privacy-friendly web analytics works, and how to add the tracking script to your website. - [Installation](https://www.openrevenue.com/docs/installation.md): Install OpenRevenue on any website with one lightweight script tag, then verify traffic in your dashboard. - [HTML installation](https://www.openrevenue.com/docs/installation/html.md): Add OpenRevenue analytics to a plain HTML website with one script tag and your project ID. - [Next.js installation](https://www.openrevenue.com/docs/installation/nextjs.md): Install OpenRevenue analytics in a Next.js app using the App Router, Pages Router, or a client component. - [React installation](https://www.openrevenue.com/docs/installation/react.md): Install OpenRevenue analytics in a React app with a script tag or component-level setup. - [Vue.js installation](https://www.openrevenue.com/docs/installation/vue.md): Install OpenRevenue analytics in a Vue app with the HTML script tag or a Vue plugin approach. - [Nuxt installation](https://www.openrevenue.com/docs/installation/nuxt.md): Install OpenRevenue analytics in Nuxt with a plugin or Nuxt config script setup. - [SvelteKit installation](https://www.openrevenue.com/docs/installation/sveltekit.md): Install OpenRevenue analytics in SvelteKit through app.html or a layout component. - [Astro installation](https://www.openrevenue.com/docs/installation/astro.md): Install OpenRevenue analytics in Astro through a layout, head tag, or reusable component. - [Angular installation](https://www.openrevenue.com/docs/installation/angular.md): Install OpenRevenue analytics in Angular through index.html or an Angular service. - [Realtime](https://www.openrevenue.com/docs/advanced/realtime.md): Understand how OpenRevenue counts active visitors and powers realtime website analytics. - [Custom events](https://www.openrevenue.com/docs/advanced/custom-events.md): Track signups, clicks, downloads, conversions, and other product actions with OpenRevenue custom events. - [Funnels](https://www.openrevenue.com/docs/advanced/funnels.md): Build conversion funnels in OpenRevenue to see how visitors move through a sequence of steps and where they drop off. - [Transactions](https://www.openrevenue.com/docs/advanced/transactions.md): Send transaction events to OpenRevenue so revenue and conversion value can appear in analytics reports. - [Revenue integrations](https://www.openrevenue.com/docs/advanced/revenue.md): Connect a payment provider like Polar, Shopify, or RevenueCat to attribute real revenue, orders, and conversion rate to your analytics. - [Integrations](https://www.openrevenue.com/docs/advanced/integrations.md): Connect Google Search Console, or import history from Google Analytics, Plausible, DataFast, Umami, Fathom, or Matomo. - [Visitors](https://www.openrevenue.com/docs/advanced/visitors.md): Explore individual visitor profiles and session timelines in OpenRevenue, all anonymous and free of personal data. - [Public stats](https://www.openrevenue.com/docs/advanced/public-stats.md): Make a project's analytics public and share a read-only stats page that anyone can open without logging in. - [Widgets](https://www.openrevenue.com/docs/advanced/widgets.md): Embed live OpenRevenue analytics on your own website: a realtime visitor counter, a traffic badge, and a last-30-minutes chart. - [Installation security](https://www.openrevenue.com/docs/advanced/security.md): Configure allowed hostnames, blocked IPs, blocked pages, and masked pages for safer OpenRevenue tracking. - [Uploaded files](https://www.openrevenue.com/docs/advanced/uploads.md): How OpenRevenue stores and manages account avatars and project icons — what we accept, where files live, and how deletion works. - [Web Vitals](https://www.openrevenue.com/docs/advanced/web-vitals.md): Learn how OpenRevenue collects Core Web Vitals and performance signals for website analytics. - [Bot traffic tracking](https://www.openrevenue.com/docs/advanced/bot-tracking.md): See when AI assistants, search engines, and model-training crawlers request your pages by adding server-side bot tracking. - [Account API](https://www.openrevenue.com/docs/api/account-api.md): Use the OpenRevenue Account API to list projects, create projects, delete projects, and manage API access. - [List projects](https://www.openrevenue.com/docs/api/account-api/list-projects.md): Returns all projects belonging to the authenticated user, ordered by creation date. - [Create project](https://www.openrevenue.com/docs/api/account-api/create-project.md): Creates a new project. The domain is automatically normalized — protocols and paths are stripped. - [Delete project](https://www.openrevenue.com/docs/api/account-api/delete-project.md): Permanently deletes a project and all its analytics data. Requires a write-scoped API key and `{"confirm":true}` in the JSON body. This action cannot be undone. - [Project API](https://www.openrevenue.com/docs/api/project-api.md): Query and manage OpenRevenue projects through the API — project details, stats, timeseries, pages, events, goals, bots, install verify, and CSV export. - [Get project](https://www.openrevenue.com/docs/api/project-api/get-project.md): Returns project details: name, timezone, public stats flag, brand color, icon, install timestamp, and whether the caller is the owner. - [Update project](https://www.openrevenue.com/docs/api/project-api/update-project.md): Updates project settings. Requires a write-scoped API key and project ownership. Pass any combination of name, timeZone, and publicStatsEnabled. - [Stats](https://www.openrevenue.com/docs/api/project-api/stats.md): Returns aggregate stats for a project over the given period: total pageviews, unique visitors, sessions, and average session duration in seconds. - [Timeseries](https://www.openrevenue.com/docs/api/project-api/timeseries.md): Returns pageviews and unique visitors bucketed over time. Granularity is hourly for the 24h period and daily for all others. - [Pages](https://www.openrevenue.com/docs/api/project-api/pages.md): Returns the top pages for the project ranked by pageviews, along with unique visitor counts per page. - [Referrers](https://www.openrevenue.com/docs/api/project-api/referrers.md): Returns traffic sources ranked by pageviews. Direct traffic (no referrer) is returned as (direct). - [Countries](https://www.openrevenue.com/docs/api/project-api/countries.md): Returns visitor breakdown by country, ranked by pageviews. Includes ISO country codes. - [Cities](https://www.openrevenue.com/docs/api/project-api/cities.md): Returns visitor breakdown by city, ranked by unique visitors. Only cities with known geo data are returned. - [Devices](https://www.openrevenue.com/docs/api/project-api/devices.md): Returns visitor breakdown by device type, browser, and operating system — all in a single response. - [Browsers](https://www.openrevenue.com/docs/api/project-api/browsers.md): Returns visitor breakdown by browser, ranked by unique visitors. - [OS](https://www.openrevenue.com/docs/api/project-api/os.md): Returns visitor breakdown by operating system, ranked by unique visitors. - [Events](https://www.openrevenue.com/docs/api/project-api/events.md): Returns custom and transaction events ranked by count for the period, including summed tracker transaction amounts when a single currency is present. Works with an API key (ClickHouse-backed). - [Goals](https://www.openrevenue.com/docs/api/project-api/goals.md): Returns project goals with current stats for the period. Prefer a session Bearer token — API keys may receive an empty goals list because the underlying action is session-only. - [Bots](https://www.openrevenue.com/docs/api/project-api/bots.md): Returns bot traffic totals, a time series, top bots, and top crawled pages. Prefer a session Bearer token — API keys may receive empty traffic because the underlying action is session-only. - [Install verify](https://www.openrevenue.com/docs/api/project-api/install-verify.md): Checks whether the tracker has started sending events for this project. Requires a write-scoped API key or session. - [Export CSV](https://www.openrevenue.com/docs/api/project-api/export.md): Downloads analytics as a CSV file (Content-Type: text/csv). Sections include overview, pages, referrers, countries, browsers, and operating systems. Works with an API key. - [MCP](https://www.openrevenue.com/docs/api/mcp.md): Connect ChatGPT, Cursor, Claude, or other MCP clients to OpenRevenue with an API key or OAuth. ## Optional - [Status](https://status.openrevenue.com) - [Support](mailto:support@openrevenue.com) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.