API & SDK Documentation

Rastrea todo. Integra en minutos.

SDK oficial @reviewo/tracker para JavaScript y TypeScript con dos canales — tracking público en el navegador y eventos de venta server-to-server — además de una API REST documentada y ejemplos listos.

Empezar a integrar Ver eventos

13 event types JS · TS SDK <42ms p95

terminal

Getting Started

3 pasos para tracking completo

Instala el SDK

Una línea, cualquier gestor de paquetes — o usa el loader JS (rv.js) en el navegador.

Configura tus claves

Publishable key para el tracking público; secret key para los eventos de venta.

Empieza a rastrear

reviewo.track.event para navegación; reviewo.events para ventas.

npm install @reviewo/tracker

tracking.ts

1import { reviewo } from '@reviewo/tracker'

3reviewo.configure({

4 baseURL: 'https://www.api.reviewo.com.br',

5 publishableKey: 'pk_rv_...'

6})

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

De page_view a order_placed, cada evento se conecta al siguiente. La API normaliza aliases automáticamente.

page_view

URL visitada

product_view

Produto visto

add_to_cart

Adicionou ao carrinho

checkout_start

Iniciou checkout

checkout_profile

Datos del comprador

checkout_shipping

Selección de envío

checkout_payment

Pagamento

purchase

Pedido confirmado

abandoned_cart

Carrinho abandonado

form_submit

Formulario enviado

custom_event

Evento livre

page_view

URL visitada

product_view

Produto visto

add_to_cart

Adicionou ao carrinho

checkout_start

Iniciou checkout

checkout_profile

Datos del comprador

checkout_shipping

Selección de envío

checkout_payment

Pagamento

purchase

Pedido confirmado

abandoned_cart

Carrinho abandonado

form_submit

Formulario enviado

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

Campos obligatorios: url

Campo	Tipo	Descripción
url*	string	URL canónica de la página visitada
title	string	Título de la página
referrer	string	Referrer canónico
viewportWidth	integer	Largura do viewport em px
viewportHeight	integer	Altura do viewport em px
scrollDepth	number	Profundidade de scroll (0-100%)

API Reference

SDK ou REST direto, tú eliges

Usa el SDK oficial para una integración rápida o realiza llamadas REST directas. La misma API por detrás.

POST/api/v1/public/trackPublic

Ingesta pública de eventos de navegación y checkout (no sensibles), identificada por la publishable key.

Auth: Publishable key · metadata.siteKey

POST/api/v1/integration/eventsServer

Eventos de venta sensibles — purchase, refund y cancel — siempre server-to-server, autenticados con la secret key e idempotentes por orderId.

Auth: Secret key · x-api-key

Request Body — Campos compartilhados

Campo	Tipo	Descripción
eventTyperequired	string	Tipo de evento de tracking público (page_view, product_view, add_to_cart, checkout_*, abandoned_cart, custom_event).
eventDatarequired	object	Payload do evento. Estrutura varia por eventType.
clickId	string	ID del Magic Link rastreado. Mín. 6 caracteres. Sin él → evento orgánico.
timestamp	string	ISO 8601 (ex: 2025-07-31T04:41:10.060Z). Omitido → hora atual.
deviceId	string	Identificador persistente do dispositivo.
metadata	object	Datos libres de la integración, persistidos como customData.

Campos de enriquecimento

Telemetría adicional para ingesta server-side: geolocalización, fingerprint y contexto del visitante

Campo	Tipo	Descripción
sessionId	string	Session ID sobrescrito manualmente.
ip	string	IP de origem.
userAgent	string	User-Agent.
fingerprint	string	Fingerprint do cliente.
origin	string	paid ou organic.
country / city / region	string	Geolocalización para enriquecer ipLocation.
lat / lon	number	Coordenadas do visitante.
timezone	string	Timezone do visitante (ex: America/Sao_Paulo).

Abrir referencia interactiva y SDKs

Referencia completa, spec OpenAPI y SDKs — abierto, sin login.

SDKs

11 plataformas, uma API

Usa el SDK oficial o realiza llamadas REST directas. La misma API por detrás.

JavaScript

TypeScript

React

Next.js

React Native

Flutter

Swift

Kotlin

Python

PHP

JavaScript

TypeScript

React

Next.js

React Native

Flutter

Swift

Kotlin

Python

PHP

Tipagem completa

TypeScript-first com autocomplete no editor.

Docs interativas

Ejemplos listos para copiar y adaptar.

Webhooks real-time

Recibe eventos de conversión en tu backend.

Sandbox

Ambiente aislado para pruebas sin afectar producción.

Server-side ready

Endpoint direto com telemetria enriquecida.

<42ms p95

Latencia ultrabaja en edge locations.

190+ edge locations

CDN global via CloudFront.

Alias automático

A API normaliza campos legados automaticamente.

Start Building

Integra en minutos, escala a millones

API key gratis, sandbox de pruebas y documentación interactiva con ejemplos listos.

Generar API Key gratis Ver referencia de eventos

$npm install @reviewo/tracker