API JavaScript
O guia a seguir o orientará na configuração e no uso da API JavaScript. Se estiver planejando uma integração completa de comércio eletrônico, consulte este guia.
Nota
Para usar os snippets do Klaviyo fornecidos abaixo, o senhor precisará atualizar o espaço reservado para API_KEY com sua chave de API pública, que pode ser encontrada aqui.
Adicionar o snippet do Klaviyo
Para começar a rastrear as pessoas, adicione o snippet abaixo à direita no modelo principal do seu site para que ele seja adicionado automaticamente a todas as páginas do site. Se o senhor tiver um desenvolvedor que adicionará esse script ao seu site, poderá enviar a ele um link para este guia.
O senhor precisa fazer uma alteração no snippet. Se o senhor for uma empresa de comércio eletrônico, remova as quatro linhas com a chamada "identify". Se o senhor for um site ou aplicativo da Web no qual as pessoas fazem login, substitua o e-mail de espaço reservado {{ email }} pela variável de modelo apropriada que contém o endereço de e-mail do usuário conectado.
Sugerimos que o código do Klaviyo seja colocado na parte inferior do modelo do seu site ou próximo a ela. Se o senhor usa o Google Analytics ou outros serviços de terceiros, pode colocar o código do Klaviyo diretamente acima ou abaixo deles.
O senhor deve estar se perguntando: "Como o uso do Klaviyo afeta o desempenho do meu site?" A resposta é que o Klaviyo não afeta em nada o desempenho do seu site. Nosso código só é carregado quando o restante do seu site termina de carregar. Além disso, a Klaviyo diz aos navegadores para armazenar em cache nosso JavaScript, de modo que seus visitantes muitas vezes nem precisam baixar nosso JavaScript sempre que mudam de página.
Verifique seu script
Depois de adicionar o JavaScript ao seu site, é possível verificar se ele está configurado corretamente inserindo o URL do seu site à direita.
Quando o script estiver em seu site, o Klaviyo começará a rastrear visitas e sessões em seu site em tempo real.
Noções básicas de API
Para fazer chamadas para a API do Klaviyo e armazenar informações sobre as pessoas, o senhor usará o objeto _learnq que é adicionado automaticamente pelo script do Klaviyo.
Para fazer uma chamada de API, o Klaviyo usa uma sintaxe especial que permite que suas chamadas de API funcionem mesmo quando nosso script ainda não foi carregado na página. O senhor criará uma matriz em que o primeiro valor é o nome do método que deseja chamar e todos os valores subsequentes são argumentos a serem passados para esse método.
Identificação de pessoas
O método identify permite que o senhor identifique e defina propriedades em um indivíduo. Esse método aceita um dicionário ou hash de propriedades. Ao identificar uma pessoa, o senhor deve incluir o endereço de e-mail dela, com a chave $email, ou um identificador exclusivo, como o ID de usuário, com a chave $id.
Depois de incluir pelo menos um desses identificadores, o senhor pode adicionar as propriedades personalizadas que desejar. As propriedades personalizadas são úteis para rastrear fatos sobre indivíduos. No Klaviyo, o senhor pode então criar segmentos de pessoas com base nessas propriedades. Por exemplo, o senhor pode querer rastrear o tipo de plano de um indivíduo ou a data de inscrição. O Klaviyo também entenderá os diferentes tipos de dados que o senhor usa, portanto, fique à vontade para usar números, booleanos e datas.
O Klaviyo tem algumas propriedades especiais que são usadas para exibir informações sobre as pessoas. Esses são: $first_name, $last_name, $phone_number, $title e $organization.
Além das propriedades que o senhor rastreia, o Klaviyo determinará automaticamente de qual site cada pessoa foi encaminhada pela primeira vez para o rastreamento de atribuição e a localização de uma pessoa com base no local em que ela acessa seu site.
Exemplo de código:
Rastreamento de eventos e ações
O método de rastreamento permite que o senhor registre eventos e ações que as pessoas realizam no seu site. Esse método aceita uma string que é o nome que o senhor dá a esse evento. Esse método também aceita um dicionário ou hash opcional de propriedades associadas a esse evento.
Por exemplo, o senhor pode rastrear quando alguém compra um item e incluir informações sobre o preço da compra e quais itens foram comprados. Se o senhor tiver um aplicativo em que as pessoas têm perfis, poderá rastrear quando alguém preenche o perfil. Se estiver planejando uma integração completa de comércio eletrônico, consulte este guia.
O rastreamento e a análise de eventos da Klaviyo são muito flexíveis, de modo que o senhor pode personalizá-los para acompanhar o que é importante para a sua empresa. Nosso método de rastreamento também compreende diferentes tipos de dados, portanto, o senhor pode usar números, booleanos e datas, e nós criaremos tabelas e gráficos inteligentes com base nos dados que o senhor enviar.
Exemplo de código: