API & SDK Documentation

Rastrea todo. Integra en minutos.

API REST con 12 tipos de evento, SDKs oficiales para 11 plataformas, latencia p95 <42ms y documentación interactiva con ejemplos listos.

Empezar a integrar Ver eventos

12 event types 11 SDKs <42ms p95

terminal

Getting Started

3 pasos para tracking completo

Instale o SDK

Uma linha. Qualquer package manager. Ou use a API REST direto.

Configura tu API Key

Genérala en el panel en Configuración → API Keys.

Comece a rastrear

12 tipos de evento listos para usar.

npm install @reviewo/sdk

tracking.ts

1import { Reviewo } from '@reviewo/sdk'

3const reviewo = new Reviewo({

4 apiKey: 'rv_live_k8x...Qm9'

5})

7// Rastreie qualquer evento

8await reviewo.track({

9 eventType: 'page_view',

10 eventData: {

11 url: '/produto/smart-tv',

12 title: 'Smart TV Samsung 65"'

13 }

14})

✓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

order_placed

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

order_placed

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. Úsala vía SDK o llamada REST directa.

Auth: API Key via header x-api-key

Request Body — Campos compartilhados

Campo	Tipo	Descripción
eventTyperequired	string	Tipo de evento. purchase es alias de order_placed.
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).

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/sdk