API & SDK Documentation

Rastreie tudo. Integre em minutos.

SDK oficial @reviewo/tracker para JavaScript e TypeScript com dois canais — tracking público no navegador e eventos de venda server-to-server — além de API REST documentada e exemplos prontos.

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

3 passos para tracking completo

1

Instale o SDK

Uma linha, em qualquer package manager — ou use o loader JS (rv.js) no navegador.

2

Configure suas chaves

Publishable key para o tracking público; secret key para os eventos de venda.

3

Comece a rastrear

reviewo.track.event para navegação; reviewo.events para vendas.

npm install @reviewo/tracker
tracking.ts
1import { reviewo } from '@reviewo/tracker'
2
3reviewo.configure({
4 baseURL: 'https://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

Do page_view ao order_placed, cada evento conecta ao próximo. A API normaliza aliases automaticamente.

page_view

URL visitada

product_view

Produto visto

add_to_cart

Adicionou ao carrinho

checkout_start

Iniciou checkout

checkout_profile

Dados do comprador

checkout_shipping

Seleção de frete

checkout_payment

Pagamento

purchase

Pedido confirmado

abandoned_cart

Carrinho abandonado

form_submit

Formulário 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 obrigatórios: url

CampoTipoDescrição
url*stringURL canônica da página visitada
titlestringTítulo da página
referrerstringReferrer canônico
viewportWidthintegerLargura do viewport em px
viewportHeightintegerAltura do viewport em px
scrollDepthnumberProfundidade de scroll (0-100%)
API Reference

SDK ou REST direto, você escolhe

Use o SDK oficial para integração rápida ou faça chamadas REST diretas — a mesma API por trás.

POST/api/v1/public/trackPublic

Ingestão pública de eventos de navegação e checkout (não-sensíveis), identificada pela publishable key.

Auth: Publishable key · metadata.siteKey

POST/api/v1/integration/eventsServer

Eventos de venda sensíveis — purchase, refund e cancel — sempre server-to-server, autenticados pela secret key e idempotentes por orderId.

Auth: Secret key · x-api-key

Request Body — Campos compartilhados

CampoTipoDescrição
eventTyperequiredstringTipo do evento de tracking público (page_view, product_view, add_to_cart, checkout_*, abandoned_cart, custom_event).
eventDatarequiredobjectPayload do evento. Estrutura varia por eventType.
clickIdstringID do Magic Link rastreado. Min 6 chars. Sem ele → evento orgânico.
timestampstringISO 8601 (ex: 2025-07-31T04:41:10.060Z). Omitido → hora atual.
deviceIdstringIdentificador persistente do dispositivo.
metadataobjectDados livres da integração, persistidos como customData.

Campos de enriquecimento

Telemetria adicional para ingestão server-side — geolocalização, fingerprint e contexto do visitante

CampoTipoDescrição
sessionIdstringSession ID sobrescrito manualmente.
ipstringIP de origem.
userAgentstringUser-Agent.
fingerprintstringFingerprint do cliente.
originstringpaid ou organic.
country / city / regionstringGeolocalização para enriquecer ipLocation.
lat / lonnumberCoordenadas do visitante.
timezonestringTimezone do visitante (ex: America/Sao_Paulo).
SDKs

11 plataformas, uma API

Use o SDK oficial ou faça chamadas REST diretas — a mesma API por trás.

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

Exemplos prontos para copiar e adaptar.

Webhooks real-time

Receba eventos de conversão no seu backend.

Sandbox

Ambiente isolado para testes sem afetar produção.

Server-side ready

Endpoint direto com telemetria enriquecida.

<42ms p95

Latência ultra-baixa em edge locations.

190+ edge locations

CDN global via CloudFront.

Alias automático

A API normaliza campos legados automaticamente.

Start Building

Integre em minutos, escale para milhões

API key gratuita, sandbox para testes, documentação interativa com exemplos prontos.

$npm install @reviewo/tracker