# Read API

JSON reads for one site. Auth is the same site id as the dashboard. No write endpoints that mint keys, delete sites, or connect processors. No CLI.

GET /api/read?site=YOUR_SITE&range=7d
GET /api/read/overview?site=YOUR_SITE&range=7d
GET /api/read/timeseries?site=YOUR_SITE&range=7d&grain=day
GET /api/read/pages?site=YOUR_SITE&range=7d
GET /api/read/referrers?site=YOUR_SITE&range=7d
GET /api/read/realtime?site=YOUR_SITE
GET /api/read/countries?site=YOUR_SITE&range=7d
GET /api/read/devices?site=YOUR_SITE&range=7d
GET /api/read/browsers?site=YOUR_SITE&range=7d
GET /api/read/campaigns?site=YOUR_SITE&range=7d
GET /api/read/payments?site=YOUR_SITE&range=7d
GET /api/read/goals?site=YOUR_SITE&range=7d
GET /api/read/funnels?site=YOUR_SITE&range=7d
GET /api/read/hostnames?site=YOUR_SITE&range=7d

range is 7d, 30d, or all. Optional from and to are Africa/Johannesburg calendar days (YYYY-MM-DD). grain=hour is for 7d or a custom span of 7 days or shorter. Empty sites return zeros and empty arrays. Amount is rand. No write or key endpoints.

HTML twin: https://www.zarstat.co.za/docs/api