Source: https://datafa.st/docs/api/website/analytics
Markdown source: https://datafa.st/docs/api/website/analytics.md
Description: Query core analytics metrics including overview, time series, metadata, realtime, and realtime map data.

# Analytics API

Use the Analytics API for high-level website metrics and realtime reporting.

| Endpoint | Method | Path | Purpose |
|---|---|---|---|
| [Time series](/docs/api/website/analytics/timeseries) | GET | `/api/v1/analytics/timeseries` | Time-bucketed metrics such as visitors, sessions, revenue, payments, and conversion rate |
| [Overview](/docs/api/website/analytics/overview) | GET | `/api/v1/analytics/overview` | Aggregate metrics for a date range or all time |
| [Metadata](/docs/api/website/analytics/metadata) | GET | `/api/v1/analytics/metadata` | Website metadata such as domain, timezone, currency, and KPI |
| [Realtime](/docs/api/website/analytics/realtime) | GET | `/api/v1/analytics/realtime` | Current active visitor count |
| [Realtime map](/docs/api/website/analytics/realtime-map) | GET | `/api/v1/analytics/realtime/map` | Realtime visitors, recent events, and recent payments |

## Time series

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

Required query parameters:

- `fields`: comma-separated metrics, for example `visitors,sessions,revenue,payments`
- `interval`: `hour`, `day`, `week`, or `month`

```http
GET /api/v1/analytics/timeseries?fields=visitors,sessions,revenue,payments&interval=day&startAt=2026-05-01&endAt=2026-05-19
```

## Overview

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

Returns totals like visitors, sessions, bounce rate, average session duration, revenue, payments, revenue per visitor, and conversion rate.

```http
GET /api/v1/analytics/overview?startAt=2026-05-01&endAt=2026-05-19
```

## Metadata and realtime

Use `metadata` to configure labels and defaults in your own UI. Use `realtime` and `realtime/map` for live dashboards.

```http
GET /api/v1/analytics/metadata
GET /api/v1/analytics/realtime
GET /api/v1/analytics/realtime/map
```

## Authentication

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

## Code examples

### Get daily time series

```bash
curl -X GET "https://datafa.st/api/v1/analytics/timeseries?fields=visitors,sessions,revenue,payments&interval=day&startAt=2026-05-01&endAt=2026-05-19" \
  -H "Authorization: Bearer df_xxx"
```

### Success response

```json
{
  "status": "success",
  "fields": ["visitors", "sessions", "revenue", "payments"],
  "interval": "day",
  "data": [
    {
      "visitors": 528,
      "sessions": 604,
      "revenue": 249,
      "payments": 4,
      "timestamp": "2026-05-01T00:00:00Z"
    }
  ],
  "totals": {
    "visitors": 14213,
    "sessions": 20181,
    "revenue": 27351,
    "payments": 317
  }
}
```