---
title: API Reference
description: Supalytics REST API
url: https://www.supalytics.co/docs/api
---



Base URL: `https://api.supalytics.co`

OpenAPI spec: [`openapi.json`](https://api.supalytics.co/openapi.json)

## Authentication

All requests require authentication via either:

### Project API Keys

Scoped to a single site. Create in **Settings → API Keys**.

```
Authorization: Bearer sly_xxx...
```

### Personal Access Tokens (PATs)

Access multiple sites with a single token. Create in **Account → Personal Access Tokens**.

```
Authorization: Bearer sly_pat_xxx...
```

When using a PAT, you must include the `domain` parameter in your requests to specify which site to query.

## Endpoints

| Endpoint                                           | Description                                              |
| -------------------------------------------------- | -------------------------------------------------------- |
| [POST /v1/query](/docs/api/query)                  | Query analytics data with flexible filtering and sorting |
| [GET /v1/realtime](/docs/api/realtime)             | Get live visitor data                                    |
| [POST /v1/events](/docs/api/server-side-events)    | Send server-side events                                  |
| [POST /v1/payments](/docs/api/revenue-attribution) | Track revenue events                                     |
| [/v1/annotations](/docs/api/annotations)           | Manage chart annotations                                 |

## Rate Limits

100 requests per minute per API key.

Rate limit headers are included in responses:

* `X-RateLimit-Limit`: Maximum requests per window
* `X-RateLimit-Remaining`: Requests remaining
* `X-RateLimit-Reset`: Unix timestamp when limit resets


---

## Other Documentation

- [Autocapture](https://www.supalytics.co/llms/docs/autocapture)
- [Backfill Existing Subscriptions](https://www.supalytics.co/llms/docs/backfill-existing-subscriptions)
- [Block Your Own Traffic](https://www.supalytics.co/llms/docs/block-your-traffic)
- [CLI](https://www.supalytics.co/llms/docs/cli)
- [Custom Events](https://www.supalytics.co/llms/docs/custom-events)
- [Features](https://www.supalytics.co/llms/docs/features)
- [Conversion Funnels](https://www.supalytics.co/llms/docs/funnels)
- [Introduction](https://www.supalytics.co/llms/docs)
- [Install Script](https://www.supalytics.co/llms/docs/install-script)
- [MRR Tracking](https://www.supalytics.co/llms/docs/mrr-tracking)
- [Revenue Attribution](https://www.supalytics.co/llms/docs/revenue-attribution)
- [Agent Skills](https://www.supalytics.co/llms/docs/skills)
- [Tracking Modes](https://www.supalytics.co/llms/docs/tracking-modes)
- [Visitor Journey](https://www.supalytics.co/llms/docs/visitor-journey)
- [Annotations](https://www.supalytics.co/llms/docs/api/annotations)
- [Error Codes](https://www.supalytics.co/llms/docs/api/errors)
- [Events (Read)](https://www.supalytics.co/llms/docs/api/events)
- [Journeys](https://www.supalytics.co/llms/docs/api/journeys)
- [Query API](https://www.supalytics.co/llms/docs/api/query)
- [Realtime API](https://www.supalytics.co/llms/docs/api/realtime)
- [Revenue Attribution API](https://www.supalytics.co/llms/docs/api/revenue-attribution)
- [Events (Write)](https://www.supalytics.co/llms/docs/api/server-side-events)