API de Eventos - Topsort Documentation

A API de Eventos permite que você envie dados de interação do usuário em tempo real para o Topsort. Esses dados alimentam a atribuição de campanhas, relatórios e algoritmos de otimização.

Tipos de Eventos

O Topsort rastreia três tipos principais de eventos:

Evento	Descrição	Quando Enviar
Impressão	Usuário visualiza um produto promovido	Quando um produto patrocinado é renderizado na tela
Clique	Usuário clica em um produto promovido	Quando um usuário clica em um produto patrocinado
Compra	Usuário completa uma transação	Quando um pedido é confirmado

Opções de Integração

API Direta

Envie eventos diretamente para a API de Eventos do Topsort para máximo controle e flexibilidade.

Analytics.js

Use nosso SDK JavaScript para rastreamento fácil de eventos no lado do cliente.

Twilio Segment

Roteie eventos através do Segment se você já o estiver usando para análises.

RudderStack

Integre via RudderStack para roteamento unificado de eventos.

Conceitos Principais

ID de Lance Resolvido

O resolvedBidId é um identificador único retornado da API de Leilões que vincula um evento a um vencedor de leilão específico. Isso é obrigatório para eventos de impressão e clique para permitir atribuição adequada.

{
  "impressions": [
    {
      "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVh...",
      "occurredAt": "2023-05-01T12:00:00Z"
    }
  ]
}

Atribuição de Eventos

Eventos são atribuídos a campanhas com base em:

Atribuição direta: Usuário interage com um produto promovido e converte
Atribuição halo: Usuário visualiza um produto promovido mas compra um produto diferente do mesmo fornecedor

Saiba mais sobre modelos de atribuição.

Etapas de Implementação

Armazene o ID de Lance Resolvido

Ao exibir vencedores de leilão, armazene o resolvedBidId da resposta do leilão.

Rastreie Impressões

Envie um evento de impressão quando um produto patrocinado se tornar visível para o usuário.

Rastreie Cliques

Envie um evento de clique quando um usuário clicar em um produto patrocinado.

Rastreie Compras

Envie eventos de compra quando pedidos forem concluídos, incluindo todos os produtos comprados.

Exemplo: Enviando Eventos

curl -X POST https://api.topsort.com/v2/events \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "impressions": [
      {
        "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4...",
        "occurredAt": "2023-05-01T12:00:00Z"
      }
    ],
    "clicks": [
      {
        "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4...",
        "occurredAt": "2023-05-01T12:00:05Z"
      }
    ]
  }'

Próximos Passos

Referência da API de Eventos - Documentação completa da API
Guia do Analytics.js - Rastreamento no lado do cliente
Modelos de Atribuição - Entendendo atribuição

​Tipos de Eventos

​Opções de Integração

API Direta

Analytics.js

Twilio Segment

RudderStack

​Conceitos Principais

​ID de Lance Resolvido

​Atribuição de Eventos

​Etapas de Implementação

​Exemplo: Enviando Eventos

​Próximos Passos