Saltar para o conteúdo principal
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:
EventoDescriçãoQuando Enviar
ImpressãoUsuário visualiza um produto promovidoQuando um produto patrocinado é renderizado na tela
CliqueUsuário clica em um produto promovidoQuando um usuário clica em um produto patrocinado
CompraUsuário completa uma transaçãoQuando um pedido é confirmado

Opções de Integração

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

1

Armazene o ID de Lance Resolvido

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

Rastreie Impressões

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

Rastreie Cliques

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

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

Precisa de ajuda com sua integração Topsort?

Fale conosco, a equipe de engenharia de integrações.Entre em contato através do seu canal de mensagens dedicado ou em support@topsort.com.Se você ainda não é cliente, agende uma demo com nossa equipe de vendas.