ConverlayConverlay

Rastreamento de Eventos

Use converlay.track(eventName, properties) para enviar eventos. O SDK enriquece automaticamente cada evento com client ID, sessão, UTMs, click IDs e estado de consentimento.

Assinatura da API

track() signature
converlay.track('event_name', {
  ecommerce: {
    transaction_id: 'ORD-123',
    value: 99.99,
    currency: 'USD',
    items: [
      {
        item_id: 'SKU-001',
        item_name: 'Classic Tee',
        price: 29.99,
        quantity: 2,
      },
    ],
  },
  userData: {
    email: 'customer@example.com',
  },
  pageType: 'product',
})

Nomes de eventos padrão

Use estes nomes de eventos para mapeamento automático para os tipos de eventos do GA4, Meta e TikTok:

Nome do eventoQuando disparar
page_viewCarregamento de página ou navegação no lado do cliente
view_itemPágina de detalhe do produto
view_item_listPágina de coleção ou resultados de busca
add_to_cartItem adicionado ao carrinho
remove_from_cartItem removido do carrinho
searchBusca submetida
begin_checkoutCheckout iniciado
add_payment_infoInformações de pagamento inseridas
add_shipping_infoInformações de envio inseridas
purchasePedido finalizado

Eventos personalizados

Você pode usar qualquer string como nome de evento. Eventos personalizados serão encaminhados como estão para destinos que os suportem.

Campos de TrackProperties

CampoTipoDescrição
ecommerceEcommerceDataDados de transação e itens
userDataUserDataPII do cliente para correspondência aprimorada (hasheado server-side)
pageTypestringRótulo do tipo de página (ex.: "product", "collection", "cart")
[key: string]unknownQuaisquer propriedades personalizadas adicionais

Exemplos

Visualizar item

typescript
converlay.track('view_item', {
  ecommerce: {
    items: [{
      item_id: 'SKU-001',
      item_name: 'Classic Tee',
      item_variant: 'Blue / Large',
      price: 29.99,
      quantity: 1,
    }],
  },
})

Adicionar ao carrinho

typescript
converlay.track('add_to_cart', {
  ecommerce: {
    value: 29.99,
    currency: 'USD',
    items: [{
      item_id: 'SKU-001',
      item_name: 'Classic Tee',
      price: 29.99,
      quantity: 1,
    }],
  },
})

Compra

typescript
converlay.track('purchase', {
  ecommerce: {
    transaction_id: 'ORD-5678',
    value: 129.99,
    currency: 'USD',
    items: [
      { item_id: 'SKU-001', item_name: 'Classic Tee', price: 29.99, quantity: 2 },
      { item_id: 'SKU-042', item_name: 'Hoodie', price: 70.01, quantity: 1 },
    ],
  },
  userData: {
    email: 'customer@example.com',
    phone: '+15551234567',
    firstName: 'Jane',
    lastName: 'Doe',
  },
})