Analytics API
Use the Analytics API for high-level website metrics and realtime reporting.
| Endpoint | Method | Path | Purpose |
|---|---|---|---|
| Time series | GET | /api/v1/analytics/timeseries | Time-bucketed metrics such as visitors, sessions, revenue, payments, and conversion rate |
| Overview | GET | /api/v1/analytics/overview | Aggregate metrics for a date range or all time |
| Metadata | GET | /api/v1/analytics/metadata | Website metadata such as domain, timezone, currency, and KPI |
| Realtime | GET | /api/v1/analytics/realtime | Current active visitor count |
| 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 examplevisitors,sessions,revenue,paymentsinterval:hour,day,week, ormonth
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.
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.GET /api/v1/analytics/metadata GET /api/v1/analytics/realtime GET /api/v1/analytics/realtime/map
Authentication
df_website API key for one website. NowebsiteIdquery parameter required.dft_account token withanalytics:read. PasswebsiteIdas a query parameter.