API dokumentáció

Csak-olvasás REST API a statisztikák programozott eléréséhez, plusz a szerveroldali hibabeküldés és a heartbeat-ping végpontok.

Hitelesítés

A /api/v1/* végpontok API-kulcsot kérnek. Kulcsot az Uptime → API-kulcsok részben (adminként) hozhatsz létre — a kulcs vagy egy adott oldalra szól, vagy az összesre. A kulcsot a Authorization fejlécben add át:

curl -H "Authorization: Bearer az_KULCS" \
  "https://zero.analyzza.com/api/v1/websites"

Alternatíva: ?api_key=az_KULCS query-paraméter. Az API kizárólag olvas — írni, törölni, beállítást módosítani nem tud.

Közös paraméterek

Paraméter	Leírás
site	A weboldal azonosítója (lásd /api/v1/websites). Egy-oldalas kulcsnál automatikus.
from, to	Időszak unix-másodpercben (to kizáró).
tzoff	Időzóna-eltolás percben a napi bontáshoz (pl. Budapest nyáron: 120).

Végpontok

GET/api/v1/websites

A kulccsal elérhető oldalak listája: [{id, name, domain}].

GET/api/v1/overview?site&from&to

Áttekintő számok az időszakra és az előző azonos hosszú időszakra: látogatók, munkamenetek, megtekintések, események, visszafordulási arány, átlagos időtartam.

curl -H "Authorization: Bearer az_KULCS" \
  "https://zero.analyzza.com/api/v1/overview?site=1&from=1751328000&to=1753920000"

GET/api/v1/timeseries?site&from&to&interval=hour|day|month

Idősor: {interval, rows: [{bucket, pageviews, visitors}]}.

GET/api/v1/top?site&from&to&type&limit

Toplisták. type: path, entry, exit, referrer, utm_source, utm_medium, utm_campaign, country, lang, browser, os, device, event. limit max. 1000.

GET/api/v1/goals?site&from&to

Konverziós célok és funnelek eredményei az időszakra.

GET/api/v1/uptime?site

Uptime-státusz: utolsó ellenőrzés, 24 órás/30 napos elérhetőség, SSL- és domain-lejárat, hibalog.

GET/api/v1/errors?site&from&to

Hibacsoportok (napi aggregátumból): üzenet, forrás, darabszám, első/utolsó előfordulás.

GET/api/v1/notices?site&limit

Értesítés-előzmények (kiemelt változások, leállások, lejáratok, anomáliák).

Szerveroldali hibabeküldés

A böngészős hibákat a mérőkód automatikusan gyűjti. A backend (PHP, Python, Node, …) hibáit ezen a nyílt végponton küldheted be — API-kulcs nem kell, a weboldal nyilvános mérési azonosítója (data-website-id) azonosít:

curl -X POST https://zero.analyzza.com/api/err \
  -H "Content-Type: application/json" \
  -d '{"w":"WEBSITE-UUID","m":"PDOException: connection refused","s":"checkout.php"}'

Mező	Leírás
w	A weboldal mérési azonosítója (kötelező).
m	Hibaüzenet (max. 300 karakter; a query-stringeket a szerver kivágja). Személyes adatot ne tegyél bele.
s	Forrás (fájl/modul, opcionális).

A hibák kizárólag napi aggregátumként tárolódnak (oldal + nap + hibacsoport + darabszám) — látogatóhoz, munkamenethez nem kötődnek.

Heartbeat-ping

A heartbeat (push) monitorokat az Uptime oldalon hozhatod létre; mindegyikhez tartozik egy tokenes URL. A cron jobod a futása végén hívja meg:

# crontab — napi backup, ami jelez, ha lefutott
15 3 * * * /usr/local/bin/backup.sh && curl -fsS https://zero.analyzza.com/api/hb/TOKEN >/dev/null

GET és POST is jó. Ha a jelzés a beállított időközön + türelmi időn túl kimarad, riasztást kapsz a beállított csatornákon.

Hibakódok

Kód	Jelentés
401	Hiányzó vagy érvénytelen API-kulcs.
400	Hibás paraméter (bad range, bad site, bad type, …).
429	Túl sok kérés (rate limit).

Analyzza Zero · zero.analyzza.com