API i MCP · Endpointy
Jedna ścieżka bazowa,
cały produkt.
Endpointy odczytu lustrzanie odbijają raporty dashboardu; dwa endpointy zapisu pozwalają maszynom budować witryny i zapisywać konwersje. Wszystko pod /api/v1 jest na żywo, uwierzytelnione kluczem Bearer obsk_ i k-anonimizowane tym samym post-filtrem, z którego korzysta dashboard.
/api/v1 — na żywo i z k-anonimizacją
Mapa endpointów.
| Metoda | Endpoint | Zwraca | Scope |
|---|---|---|---|
| GET | /api/v1/overview | KPI, trend, porównanie wdrożeń, anomalie | read:reports |
| GET | /api/v1/pages | odsłony per ścieżka, zaangażowanie, wyjścia, scroll, frustracja, CWV | read:reports |
| GET | /api/v1/acquisition | kanały, UTM, kraje, urządzenia | read:reports |
| GET | /api/v1/realtime | aktywni odwiedzający, żywe strony, żywe źródła, sparkline | read:reports |
| GET | /api/v1/vitals | percentyle CWV + rozkłady, per strona/urządzenie | read:reports |
| GET | /api/v1/sessions | ostatnie sesje z flagami (rage, multitab, błędy) | read:sessions |
| GET | /api/v1/session/{id} | pełna oś czasu per karta dla jednej sesji | read:sessions |
| GET | /api/v1/heatmap | warstwy kliknięć / rage / martwych kliknięć / scrolla + ranking elementów | read:heatmaps |
| GET | /api/v1/frustration | ranking + przyczyny źródłowe per ścieżka + drop-off formularzy | read:heatmaps |
| GET | /api/v1/anomalies · deploy · forms · sites | karty anomalii, delty wdrożeń, wycieki formularzy, rejestr | read:* |
| POST | /api/v1/sites | programowe tworzenie witryny + zweryfikowany snippet — buduj witryny z CI | write:sites |
| POST | /api/v1/events | cele i konwersje po stronie serwera (przekazywane ścieżką s2s collectora) | write:events |
Jeszcze ponad 40 wewnętrznych endpointów napędza dashboard. Wszystkie odpowiedzi v1 przechodzą post-filtr k-anonimowości — API nie może przeciec temu, co dashboard by ukrył.
Uczciwość odpowiedzi
Plakietki płyną także przez API.
Dashboard opisuje każdą liczbę jako exact, estimated, sampled albo suppressed — i odpowiedzi API niosą tę samą uczciwość. Twój magazyn danych, Twoje skrypty i Twoi agenci widzą te same kwalifikatory, co Twoi analitycy.
| exact | policzone wprost, bez modelowania — liczba jest liczbą |
| estimated | urządzenia to szacowane urządzenia-dni, nie ludzie — opisane jako takie |
| sampled | pochodzą z próby, oznaczone na poziomie metryki |
| suppressed | wiersze poniżej progu k-anonimowości nigdy nie opuszczają serwera — nie istnieją dla nikogo |
Od czego zacząć
Dwa endpointy, większość roboty.
Pobieraj /api/v1/pages i /api/v1/vitals co noc i masz magazyn danych z uczciwymi agregatami. Strona zapisu jest równie mała: POST /api/v1/sites z CI rejestruje środowisko preview, a POST /api/v1/events zapisuje konwersję testu dymnego, która dowodzi, że lejek działa.
Odczyt jest scope'owany per klucz
Klucz read:reports widzi tylko witryny wymienione na jego liście dozwolonych — rejestr istnieje, dane zostają za bramą.
Zapis to inny scope
Tworzenie witryn i zapis zdarzeń siedzi za write:sites i write:events — klucze tylko do odczytu nie zrobią ani jednego, ani drugiego. Nigdy.
Uczciwe liczby,
programowo.
Pełna mapa /api/v1 trafia do Twojego wdrożenia — z kluczami ze scope'ami w zestawie.