Stats API Reference

Query your analytics data programmatically. All endpoints are read-only.

Authentication

Pass your site API key in the x-api-key header:

curl "https://API_URL/api/stats/SITE_ID/summary" \
  -H "x-api-key: ttt_your_site_api_key"

401

Missing key

403

Invalid key

404

Site not found

Common Parameters

ParameterDefaultDescription
from7 days agoStart date (YYYY-MM-DD)
toTodayEnd date (YYYY-MM-DD)

Endpoints

GET/api/stats/{site_id}/summary

Overview stats for the date range.

{
  "site_id": "abc123",
  "period": { "from": "2026-03-20", "to": "2026-03-27" },
  "pageviews": 12453,
  "unique_visitors": 8721,
  "visit_duration_seconds": 42,
  "top_pages": [
    { "url": "/", "pageviews": 3200, "unique_visitors": 2800 }
  ],
  "top_referrers": [
    { "referrer": "https://www.google.com/", "pageviews": 4500 }
  ],
  "top_countries": [
    { "country": "AU", "pageviews": 5200 }
  ]
}

GET/api/stats/{site_id}/pageviews

Pageviews over time.

ParameterDefaultDescription
granularitydayday or hour
{
  "site_id": "abc123",
  "granularity": "day",
  "data": [
    { "date": "2026-03-20", "pageviews": 1500, "unique_visitors": 1100 },
    { "date": "2026-03-21", "pageviews": 1800, "unique_visitors": 1300 }
  ]
}

GET/api/stats/{site_id}/pages

Top pages ranked by views.

ParameterDefaultDescription
limit20Max results
{
  "data": [
    { "url": "/", "pageviews": 3200, "unique_visitors": 2800 },
    { "url": "/pricing", "pageviews": 1800, "unique_visitors": 1600 }
  ]
}

GET/api/stats/{site_id}/referrers

Top traffic sources. Direct visits shown as (direct).

ParameterDefaultDescription
limit20Max results
{
  "data": [
    { "referrer": "https://www.google.com/", "pageviews": 4500, "unique_visitors": 4000 },
    { "referrer": "(direct)", "pageviews": 2000, "unique_visitors": 1800 }
  ]
}

GET/api/stats/{site_id}/countries

Pageviews by 2-letter country code (ISO 3166-1).

{
  "data": [
    { "country": "US", "pageviews": 5200 },
    { "country": "AU", "pageviews": 2100 }
  ]
}

GET/api/stats/{site_id}/devices

Device type, browser, and operating system breakdown.

{
  "devices": [
    { "type": "desktop", "pageviews": 8000 },
    { "type": "mobile", "pageviews": 4000 }
  ],
  "browsers": [
    { "name": "Chrome", "pageviews": 7500 },
    { "name": "Safari", "pageviews": 3200 }
  ],
  "os": [
    { "name": "Windows", "pageviews": 5000 },
    { "name": "macOS", "pageviews": 3500 }
  ]
}

Notes

  • All timestamps are in UTC
  • Bot traffic is automatically excluded from all results