Eventos de Clique

Rota de tracking que representa a ação de clique em um produto do resultado da busca (/search, /navigates, /hotsites, /autocompletes e /pages) ou clique em "adicionar ao carrinho" em produtos do resultado da busca. Para cada produto do resultado de busca, há o campo clickUrl que já possui os parâmetros de apikey e trackingId. Ex: clickUrl: "/search/v3/clicks?apiKey=&trackingId=eyJzZWFyY2hJZCI..."

Tracking de eventos

Cada produto do resultado da busca nas rotas /search, /navigates, /hotsites e /autocompletes contém um campo chamado clickUrl.

Este campo fornece uma URL pré montada na rota /clicks da API de Busca que deverá ser usada para registrar todos os eventos de click dos usuários da aplicação. É por meio destes registros que geramos métricas de performance da busca, além de melhorar as estratégias para acertar em cheio cada resultado.

O deviceId é o identificador único do device do usuário e é usado pelo sistema para recuperar o histórico de visitas do usuário a fim de realizar o tracking de eventos da Busca. Por este motivo, é muito importante que o deviceId seja o mesmo em todos os eventos do mesmo usuário naquele device.

  • Caso a coleta de eventos seja realizada pelos nossos scripts (através do window.linxMeta), é necessário que seja utilizado o mesmo valor correspondente de deviceId. Este campo é disponibilizado pelos scripts de coleta no domínio do lojista, no cookie chaordic_browserId.
  • Se a coleta de eventos for chamada via API, o gerenciamento do deviceId deve ser feito pelo lojista.

A clickUrl deverá ser adicionada a URL base da API, concatenando os parâmetros exigidos pela rota de click:

Valid clickUrl
https://api.linximpulse.com/engage/search/v3/clicks?apikey=<my-api-key>&trackingId=<really-big-tracking-id-hash>&deviceid=<user-device-id>&source=desktop
Para garantir o envio do click, evitando que o browser cancele a requisição caso a página de produto seja carregada antes que o disparo, recomendamos duas implementações:
  • Disparar o evento de click somente depois que o usuário acessar a página do produto
  • Para browsers mais novos, utilizar a Beacon API

Query Params

apiKey
stringrequired

ID interno de identificação da sua loja.

Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

secretKey
stringrequired

Chave de acesso para autenticar a requisição. Pode ser substituída pelo parâmetro origin quando a requisição é feita via frontend para não expor a chave.

Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

trackingId
stringrequired

Identificador único de tracking. Fornecido pelo resultado de busca.

deviceId
stringrequired

Identificador único do dispositivo utiilizado.

source
stringrequired

Origem do dispositivo utilizado. Os tipos padrões são:
  • desktop
  • mobile
  • app
Novos canais podem ser criados no Dashboard da Busca, caso os canais padrões não atendam a necessidade.
Caso um valor inválido seja informado, irá impactar o registro de métricas de desempenho e KPIs da solução de busca.

userId
string

Id do usuário. Deve ser o mesmo identificador utilizado no site.

interactionType
string default: PRODUCT_VIEW

Tipo de interação do clique. Os tipos suportados são:
  • PRODUCT_VIEW
  • ADD_TO_CART

Edit this page on GitHub
Typescript
const fetch = require('node-fetch');

const url = 'https://api.linximpulse.com/engage/search/v3/pages';
const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
curl
curl -v -G "https://api.linximpulse.com/engage/search/v3/pages" \
  -d apiKey="<my-apikey>" \
  -d secretKey="<my-secret-key>"