> ## Documentation Index
> Fetch the complete documentation index at: https://docs.openrevenue.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Project API

> Query and manage OpenRevenue projects through the API — project details, stats, timeseries, pages, events, goals, bots, install verify, and CSV export.

> [!NOTE]
>
> Replace `{domain}` in each endpoint with your project's domain, e.g. `example.com`. All endpoints require a Bearer token; see [Authentication](https://docs.openrevenue.com/api/account-api.md#authentication). Goals and bots prefer a session Bearer (API keys may get empty results); events and export work with an API key.

## Endpoints

| Method | Endpoint | Path | Description |
| - | - | - | - |
| `GET` | [Get project](https://docs.openrevenue.com/api/project-api/get-project.md) | `/v1/projects/{domain}` | Return project details, timezone, and install status. |
| `PATCH` | [Update project](https://docs.openrevenue.com/api/project-api/update-project.md) | `/v1/projects/{domain}` | Update name, timezone, or public stats (write, owner only). |
| `GET` | [Stats](https://docs.openrevenue.com/api/project-api/stats.md) | `/v1/projects/{domain}/stats` | Return headline metrics: visitors, pageviews, bounce rate, and duration. |
| `GET` | [Timeseries](https://docs.openrevenue.com/api/project-api/timeseries.md) | `/v1/projects/{domain}/timeseries` | Return a metric bucketed over time for charts. |
| `GET` | [Pages](https://docs.openrevenue.com/api/project-api/pages.md) | `/v1/projects/{domain}/pages` | Return top pages by pageviews and visitors. |
| `GET` | [Referrers](https://docs.openrevenue.com/api/project-api/referrers.md) | `/v1/projects/{domain}/referrers` | Return traffic sources and referring domains. |
| `GET` | [Countries](https://docs.openrevenue.com/api/project-api/countries.md) | `/v1/projects/{domain}/countries` | Return visitors broken down by country. |
| `GET` | [Cities](https://docs.openrevenue.com/api/project-api/cities.md) | `/v1/projects/{domain}/cities` | Return visitors broken down by city. |
| `GET` | [Devices](https://docs.openrevenue.com/api/project-api/devices.md) | `/v1/projects/{domain}/devices` | Return visitors by device type: desktop, mobile, tablet. |
| `GET` | [Browsers](https://docs.openrevenue.com/api/project-api/browsers.md) | `/v1/projects/{domain}/browsers` | Return visitors broken down by browser. |
| `GET` | [OS](https://docs.openrevenue.com/api/project-api/os.md) | `/v1/projects/{domain}/os` | Return visitors broken down by operating system. |
| `GET` | [Events](https://docs.openrevenue.com/api/project-api/events.md) | `/v1/projects/{domain}/events` | Return custom and transaction events ranked by count, with amounts when present. |
| `GET` | [Goals](https://docs.openrevenue.com/api/project-api/goals.md) | `/v1/projects/{domain}/goals` | Return goals with current stats (session preferred). |
| `GET` | [Bots](https://docs.openrevenue.com/api/project-api/bots.md) | `/v1/projects/{domain}/bots` | Return bot traffic totals and top crawlers (session preferred). |
| `POST` | [Install verify](https://docs.openrevenue.com/api/project-api/install-verify.md) | `/v1/projects/{domain}/install/verify` | Check whether the tracker is installed and sending events. |
| `GET` | [Export CSV](https://docs.openrevenue.com/api/project-api/export.md) | `/v1/projects/{domain}/export` | Download analytics as a CSV file. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.