API & SDK Documentation

Traccia tutto. Integra in minuti.

SDK ufficiale @reviewo/tracker per JavaScript e TypeScript con due canali — tracking pubblico nel browser ed eventi di vendita server-to-server — oltre a una API REST documentata ed esempi pronti.

13 event types JS · TS SDK <42ms p95
terminal
$
Getting Started

3 passaggi per tracking completo

1

Installa l'SDK

Una riga, qualsiasi package manager — o usa il loader JS (rv.js) nel browser.

2

Configura le tue chiavi

Publishable key per il tracking pubblico; secret key per gli eventi di vendita.

3

Inizia a tracciare

reviewo.track.event per la navigazione; reviewo.events per le vendite.

npm install @reviewo/tracker
tracking.ts
1import { reviewo } from '@reviewo/tracker'
2
3reviewo.configure({
4 baseURL: 'https://www.api.reviewo.com.br',
5 publishableKey: 'pk_rv_...'
6})
7
8// Rastreie qualquer evento
9await reviewo.track.event({
10 eventType: 'page_view',
11 eventData: {
12 url: '/produto/smart-tv',
13 title: 'Smart TV Samsung 65"'
14 }
15})
page_view rastreado —/produto/smart-tv(12ms)
Event Pipeline

12 eventos, um fluxo completo

Da page_view a order_placed, ogni evento si collega al successivo. L’API normalizza automaticamente gli alias.

page_view

URL visitada

product_view

Produto visto

add_to_cart

Adicionou ao carrinho

checkout_start

Iniciou checkout

checkout_profile

Dati acquirente

checkout_shipping

Selezione spedizione

checkout_payment

Pagamento

purchase

Pedido confirmado

abandoned_cart

Carrinho abandonado

form_submit

Modulo inviato

custom_event

Evento livre

Event Reference

Explore cada tipo de evento

POST /api/v1/public/track
page_view
{
  "clickId": "d8b947b875cc42cc...",
  "eventType": "page_view",
  "eventData": {
    "url": "/produto/smart-tv",
    "title": "Smart TV Samsung 65\"",
    "referrer": "https://google.com",
    "viewportWidth": 1920,
    "scrollDepth": 45
  }
}
200{ "ok": true, "eventId": "evt_..." }

page_view

Campi obbligatori: url

CampoTipoDescrizione
url*stringURL canonico della pagina visitata
titlestringTitolo della pagina
referrerstringReferrer canonico
viewportWidthintegerLargura do viewport em px
viewportHeightintegerAltura do viewport em px
scrollDepthnumberProfundidade de scroll (0-100%)
API Reference

SDK ou REST direto, scegli tu

Usa l’SDK ufficiale per integrare rapidamente o fai chiamate REST dirette: la stessa API sotto.

POST/api/v1/public/trackPublic

Ingestione pubblica di eventi di navigazione e checkout (non sensibili), identificata dalla publishable key.

Auth: Publishable key · metadata.siteKey

POST/api/v1/integration/eventsServer

Eventi di vendita sensibili — purchase, refund e cancel — sempre server-to-server, autenticati con la secret key e idempotenti per orderId.

Auth: Secret key · x-api-key

Request Body — Campos compartilhados

CampoTipoDescrizione
eventTyperequiredstringTipo di evento di tracking pubblico (page_view, product_view, add_to_cart, checkout_*, abandoned_cart, custom_event).
eventDatarequiredobjectPayload do evento. Estrutura varia por eventType.
clickIdstringID del Magic Link tracciato. Min 6 caratteri. Senza → evento organico.
timestampstringISO 8601 (ex: 2025-07-31T04:41:10.060Z). Omitido → hora atual.
deviceIdstringIdentificador persistente do dispositivo.
metadataobjectDati liberi dell’integrazione, salvati come customData.

Campos de enriquecimento

Telemetria aggiuntiva per ingestione server-side: geolocalizzazione, fingerprint e contesto del visitatore

CampoTipoDescrizione
sessionIdstringSession ID sobrescrito manualmente.
ipstringIP de origem.
userAgentstringUser-Agent.
fingerprintstringFingerprint do cliente.
originstringpaid ou organic.
country / city / regionstringGeolocalizzazione per arricchire ipLocation.
lat / lonnumberCoordenadas do visitante.
timezonestringTimezone do visitante (ex: America/Sao_Paulo).
Apri il riferimento interattivo e gli SDK

Riferimento completo, spec OpenAPI e SDK — aperto, senza login.

SDKs

11 plataformas, uma API

Usa l’SDK ufficiale o fai chiamate REST dirette: la stessa API sotto.

JavaScript
TypeScript
React
Next.js
React Native
Flutter
Swift
Kotlin
Python
Go
PHP
JavaScript
TypeScript
React
Next.js
React Native
Flutter
Swift
Kotlin
Python
Go
PHP

Tipagem completa

TypeScript-first com autocomplete no editor.

Docs interativas

Esempi pronti da copiare e adattare.

Webhooks real-time

Ricevi eventi di conversione nel tuo backend.

Sandbox

Ambiente isolato per test senza impattare la produzione.

Server-side ready

Endpoint direto com telemetria enriquecida.

<42ms p95

Latenza ultra-bassa su edge location.

190+ edge locations

CDN global via CloudFront.

Alias automatico

A API normaliza campos legados automaticamente.

Start Building

Integra in minuti, scala a milioni

API key gratuita, sandbox per test e documentazione interattiva con esempi pronti.

$npm install @reviewo/tracker