Pular para o conteúdo principal

Visão Geral

O Lead Tracking SDK possui os seguintes objetos e métodos:

LeadTracking​

O objeto global criado logo após o carregamento do SDK e validação do Lead.

LeadTracking.lead​

Traz todos os atributos e métodos relativos ao lead.

const lead = LeadTracking.lead;

Atributos e Métodos do Lead​

getLeadFromCookie()​

Retorna os dados decriptados do lead que foram setados no cookie. Caso não exista o cookie, retorna nulo.

const leadData = lead.getLeadFromCookie();

identify(leadData)​

Gera um identificador único, a partir dos dados de conversão e gera um cookie. Se algum dado passado for inválido, será retornado um erro. O objeto leadData possui a seguinte estrutura:

const leadData = {
  email: 'lead@mail.com',
  name: 'Lead Name',
  phone: '19912345678',
};

isIdentified​

Retorna um booleano indicando se o lead já foi identificado.

const isIdentified = lead.isIdentified;

leadDataIfValid​

Retorna os dados do lead já validados. Caso não exista, retorna nulo.

const leadData = lead.leadDataIfValid;

LeadTracking.listeners​

Traz todos os atributos e métodos relativos aos eventos que estão sendo "escutados".

const listeners = LeadTracking.listeners;

Atributos e Métodos dos Listeners​

startListening()​

Inicia a escuta dos eventos pelo SDK.

listeners.startListening();

LeadTracking.tracking​

Traz a centralização do lead e os eventos realizados pelo mesmo.

const tracking = LeadTracking.tracking;

Atributos e Métodos do Tracking​

addNewEvent(event)​

Registra e envia um novo evento. Estrutura do evento:

const event = {
  id: 'valid_event_id',
  timestamp: 1704799606000,
  type: 'pageView',
  pageInfo: {
    title: 'Renda Variável',
    origin: 'https://eqi.com.br',
    path: '/renda-variavel',
    params: {
      campaignId: 'valid_campaignId',
      utm_source: 'valid_utm_source',
      utm_content: 'valid_utm_content',
      utm_campaign: 'valid_utm_campaign',
      utm_medium: 'valid_utm_medium',
      gclid: 'valid_gclid',
    },
  },
  context: {
    device: 'desktop',
  },
  lead: {
    id: 'valid_user_id',
    email: 'lead@mail.com',
    name: 'Lead Name',
    phone: '19912345678',
  },
};

⚠️ Algumas propriedades do evento acima são opcionais. Para saber mais sobre os eventos disponiveis e quais os dados obrigatorios e opcionais, consulte a página de Eventos.

events​

Retorna os eventos já realizados pelo lead.

const events = tracking.events;

lead​

Retorna o lead que está sendo trackeado.

const lead = tracking.lead;