Source: https://datafa.st/docs/api/website/analytics/realtime
Markdown source: https://datafa.st/docs/api/website/analytics/realtime.md
Description: Return the current active visitor count.

# Get realtime visitors

`GET https://datafa.st/api/v1/analytics/realtime`

Return the current active visitor count.

## Request

### Authentication

- `df_` website API key for one website.
- `dft_` account token with `analytics:read`. Pass `websiteId` as a query parameter.


### Query parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `fields` | string | No | Controls which realtime metric is returned. Possible values: `visitors`. Example: `fields=visitors`. |

## Response

Returns a JSON object with `status` and endpoint-specific fields.

### Response fields

| Field | Type | Description |
| --- | --- | --- |
| `data[].visitors` | number | Number of visitors active in the realtime window. Use it for live counters or status widgets. |

### Errors

Common errors include `400` for invalid input, `401` for missing or invalid tokens, `403` for missing permission or suspended tracking, `404` for missing resources, and `500` for server errors.

## Code examples

### Example request

```bash
curl -X GET "https://datafa.st/api/v1/analytics/realtime" \
  -H "Authorization: Bearer df_xxx"
```

### Success response

```json
{
  "status": "success",
  "data": [{
    "visitors": 42
  }]
}
```