---
title: Realtime API
description: GET /v1/realtime - Get live visitor data
url: https://www.supalytics.co/docs/api/realtime
---



Get real-time analytics data showing currently active visitors on your site (last 2 minutes).

## Endpoint

```
GET https://api.supalytics.co/v1/realtime
```

## Authentication

Requires an API key or Personal Access Token with `analytics:read` scope.

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

When using a PAT, you must include the `domain` query parameter.

## Query Parameters

| Parameter | Type   | Default | Description                                      |
| --------- | ------ | ------- | ------------------------------------------------ |
| `domain`  | string | -       | Site domain to query. Required when using a PAT. |

## Response

```json
{
  "data": {
    "active_visitors": 42,
    "pages": [
      { "page": "/", "visitors": 15 },
      { "page": "/pricing", "visitors": 8 },
      { "page": "/blog/getting-started", "visitors": 5 }
    ],
    "countries": [
      { "country": "US", "visitors": 20 },
      { "country": "DE", "visitors": 12 },
      { "country": "GB", "visitors": 5 }
    ],
    "referrers": [
      { "referrer": "google.com", "visitors": 10 },
      { "referrer": "twitter.com", "visitors": 8 },
      { "referrer": "direct", "visitors": 15 }
    ]
  },
  "meta": {
    "domain": "example.com",
    "timestamp": "2024-12-22T15:30:00Z"
  }
}
```

### Response Fields

| Field                  | Description                                     |
| ---------------------- | ----------------------------------------------- |
| `data.active_visitors` | Number of unique visitors in the last 2 minutes |
| `data.pages`           | Top 10 pages by active visitors                 |
| `data.countries`       | Top 10 countries by active visitors             |
| `data.referrers`       | Top 10 referrers by active visitors             |
| `meta.domain`          | The website domain                              |
| `meta.timestamp`       | When the data was fetched (ISO 8601)            |

## Rate Limits

* **100 requests per minute** per API key

## Example

```bash
curl https://api.supalytics.co/v1/realtime \
  -H "Authorization: Bearer sly_xxx..."
```


---

## 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)
- [API Reference](https://www.supalytics.co/llms/docs/api)
- [Journeys](https://www.supalytics.co/llms/docs/api/journeys)
- [Query API](https://www.supalytics.co/llms/docs/api/query)
- [Revenue Attribution API](https://www.supalytics.co/llms/docs/api/revenue-attribution)
- [Events (Write)](https://www.supalytics.co/llms/docs/api/server-side-events)