Disponível para gravações e mapas de calor com os planos Observe 
ou 
. Disponível para feedback e pesquisas com os planos Ask ou . Consulte a página de preços do Hotjar para obter informações sobre planos e preços.
A API Identify do Hotjar permite que você passe dados sobre seus usuários para o Hotjar usando Javascript, salvando-os como Atributos do usuário. Esses atributos de usuário podem ser usados pelo Hotjar para permitir a filtragem e a segmentação avançadas, fornecendo insights de qualidade mais rapidamente do que antes. É possível enviar até 100 atributos de usuário em qualquer site, com qualquer número de usuários associados a esses atributos.
Os atributos de usuário podem ser usados para filtrar gravações e direcionar widgets de pesquisas e feedback, além de realizar solicitações de pesquisa e exclusão de usuários por ID de usuário.
Siga os links abaixo para saber mais sobre os atributos de usuário:
- Visão geral
- Manuseio de IDs de usuário
- Como fazer chamadas para identificar
- Valores de atributos de usuário
- Manuseio de endereços de e-mail
- Exemplos de transmissão de atributos de usuário para o Hotjar
- Uso da API Identify em conformidade com a lei
- Desativação de atributos de usuário
- Exclusão de atributos de usuário
- Práticas recomendadas
- Perguntas frequentes
Você pode enviar atributos de usuário usando o Google Tag Manager ou o Segment
É possível começar a enviar atributos de usuário para o Hotjar usando o Google Tag Manager ou o Segment. Para obter mais detalhes, consulte nosso artigo Como enviar atributos de usuário com o Google Tag Manager ou, se estiver usando o Segment, visite nosso guia Usando o Hotjar com o Segment.
Visão geral
Os atributos do usuário são valores de dados sobre os usuários do seu site passados para o Hotjar a partir do código do lado do cliente por meio da API de identificação do Hotjar. Essa API está disponível em todas as páginas que contêm o código de rastreamento do Hotjar.
Esses dados são passados para o Hotjar em pares de valores-chave como uma chamada AJAX assíncrona para os servidores do Hotjar. Esses valores são associados a um ID de usuário, um valor exclusivamente identificável passado ao Hotjar no seu código a partir de um valor de ID de usuário do seu banco de dados de usuários. Isso permite que o Hotjar associe os dados coletados sobre eles com o mesmo ID de usuário que você usa em seu próprio banco de dados, bem como procure informações de usuário mantidas no Hotjar sobre esse usuário.
Há quatro fases no processo de envio e uso de atributos de usuário com o Hotjar.
- Obter os dados de seu site.
- Passe os dados para o Hotjar por meio da API Identify.
- O Hotjar armazena os dados sobre cada usuário como atributos de usuário em relação ao seu user_id.
- Agora, você pode usar as ferramentas do Hotjar para direcionar e filtrar por Atributos do usuário.
Como fazer chamadas para o Identify
Antes de começar a fazer chamadas para o Identify, os atributos de usuário devem ser ativados nas configurações do Hotjar para cada site com o qual você deseja usar os atributos de usuário.
Ativação e desativação de atributos de usuário
A capacidade de acessar a API do Identify e os Atributos do usuário será ativada por padrão se esse recurso estiver incluído no seu plano do Hotjar. No entanto, se os atributos de usuário tiverem sido desativados no passado, talvez seja necessário reativá-los para uso.
Na página Atributos do usuário(Configurações > Atributos do usuário), localize o Site ao qual deseja adicionar Atributos do usuário usando o menu suspenso de seleção. Você verá algo parecido com isto, mostrando o status da implementação dos atributos de usuário:
Você também pode desativar os atributos de usuário nessa página. Depois de selecionar um site com atributos de usuário ativados, clique em Disable User Attributes (Desativar atributos de usuário). Depois de fazer isso, outras chamadas para a API serão bloqueadas. O botão "Disable User Attributes" (Desativar atributos do usuário) só aparecerá depois que os dados de atributos do usuário forem recebidos pelo Hotjar, mas não antes.
Todos os relatórios que dependem dos atributos do usuário para fins de segmentação serão desativados e você não poderá reativá-los, a menos que altere as opções de segmentação ou reative os atributos do usuário.
Se quiser evitar que os atributos de usuário sejam enviados no futuro, remova o código da API Identify do seu site. Depois que o código for excluído do seu site, os atributos de usuário coletados anteriormente ainda existirão, mas não serão mais atualizados ou adicionados a novos usuários do seu site.
A chamada à API
Este é o formato de uma chamada para a API Identify:
hj('identify', userId, {
user_attribute: value
});
- O primeiro parâmetro deve sempre conter o valor da cadeia de caracteres "identify".
- O segundo deve ser uma cadeia de caracteres que contém o ID de um usuário no seu site, do seu próprio banco de dados de usuários, ou nulo se não for conhecido.
- O terceiro é uma série de pares de valores chave dentro de um objeto. A chave fornece o nome do atributo de usuário e o valor define o tipo de um atributo de usuário e seu valor para esse usuário.
Os valores passados para essa chamada devem vir da base de código de seu próprio site. Esses valores podem ser extraídos diretamente de seus servidores ou gerados no lado do cliente.
Depois de enviados ao Hotjar, esses atributos e os valores de cada usuário são armazenados nos servidores do Hotjar. Sempre que for feita uma chamada para o Identify, os valores armazenados nos servidores do Hotjar serão substituídos pelos valores mais recentes desses atributos.
Você pode procurar todos os atributos enviados ao Hotjar na página de configurações de Atributos do usuário. Você pode usar o recurso User Lookup para inspecionar quais valores foram passados para um usuário específico em seu site.
Desde que um usuário seja identificado durante sua sessão, o Hotjar poderá associar IDs de usuário e atributos de usuário com a gravação de uma sessão e oferecer um direcionamento detalhado do widget de feedback, permitindo que você obtenha feedback direcionado de usuários específicos usando feedback e pesquisas. Por exemplo: "Quero que esta pesquisa seja direcionada somente a clientes pagantes que fizeram uma compra há mais de 10 dias".
As gravações serão salvas com base nos valores mais recentes enviados ao Hotjar durante a sessão.
Se você enviar várias chamadas para o Identify durante a sessão de um usuário, o Hotjar sempre atualizará com os valores mais recentes. Isso significa que é importante que as IDs de usuário e os atributos de usuário sejam enviados de forma consistente em cada chamada, permitindo que o Hotjar conecte uma gravação a um usuário específico.
Manuseio de IDs de usuário
O segundo argumento passado ao Hotjar por meio da chamada Identify API deve ser um ID de usuário exclusivamente identificável do banco de dados do seu próprio site. Os atributos do usuário são associados a essa ID de usuário.
O ID do usuário deve ser exclusivo por usuário, mas não deve conter informações pessoais. Também deve ser um valor que nunca muda para esse usuário. Depois de definir um ID de usuário no Hotjar, ele não poderá ser alterado. Se for alterado, o Hotjar considerará que se trata de um usuário totalmente novo.
Se um ID de usuário for conhecido, o ID do Hotjar do usuário será associado ao seu ID de usuário. Um Hotjar ID é um ID de usuário exclusivo gerado aleatoriamente, criado no nível do Hotjar Site. Se um usuário não tiver um ID de usuário quando visitar um site inicialmente, o ID do Hotjar será associado ao ID de usuário quando a chamada para a API de identificação com um ID de usuário for feita.
É útil trabalhar isso com um exemplo.
Digamos que temos uma usuária, Rachel. Ela visita o site 3 vezes em 2 dispositivos diferentes.
-
Sessão A - Rachel visita radbooks.com em seu tablet.
- Ela ainda não é uma usuária do site e recebe um Hotjar ID de 123
-
Sessão B - Rachel visita o site em seu celular.
- Ela ainda não é uma usuária e recebe um Hotjar ID de 456
-
Sessão C - Rachel retorna ao site a partir de seu celular.
- O Hotjar a reconhece com o Hotjar ID de 456.
- Ela então registra uma conta.
- Sua chamada para o Identify atribui a ela um ID de usuário ABC, usando o mesmo ID de usuário que você tem para ela em seu banco de dados.
Como a associamos a um ID de usuário no seu site, conectamos todos os dados associados ao Hotjar ID 456 com o ID de usuário ABC dela, mesmo que ela não tenha feito login durante a sessão B.
Se Rachel visitar o site em seu tablet em uma quarta sessão e, dessa vez, fizer login, o Hotjar reunirá os dados da Sessão A, da Sessão B e da Sessão C, fornecendo uma visão completa das interações dela com o seu site.
E se você não tiver um ID de usuário?
Se o ID do usuário não for conhecido, você deverá passar um valor nulo para o segundo parâmetro. Ao fazer isso, todos os atributos de usuário passados para a API Identify serão associados à ID do Hotjar do usuário.
Não passe informações de identificação pessoal como um atributo de usuário sem um ID de usuário
Se um ID de usuário não for conhecido (passando um valor nulo), qualquer outro Atributo de usuário passado ao Hotjar não deverá conter nenhuma informação de identificação pessoal (PII). A sua capacidade de pesquisar Atributos de Usuário associados a um usuário individual no Hotjar depende da sua capacidade de pesquisar o ID de Usuário dele. O Hotjar não tem como recuperar ou excluir esses dados, a menos que você exclua todo o Site no Hotjar.
Valores de atributo de usuário
Você pode passar os seguintes valores para uma chave de atributo de usuário usando a API de identificação. Caracteres especiais não podem ser usados no momento.
Manuseio de endereços de e-mail
No momento, há uma chave de atributo de usuário para endereços de e-mail: email. Os endereços de e-mail devem ser passados como strings para email. Por exemplo:
hj('identify', userId, {
email: 'test@test.com'
});
Se qualquer outro atributo de usuário de um tipo de cadeia de caracteres contiver um endereço de e-mail, ele será rejeitado, o que significa que você só deve usar `email` para passar endereços de e-mail.
Endereços de e-mail e IDs de usuário
O user_id pode assumir a forma de endereços de e-mail, portanto, se a chave primária do seu banco de dados para os usuários for o endereço de e-mail, ele poderá ser usado como user_id. Isso deve ser usado apenas como último recurso. Se a chave primária de um usuário em seu banco de dados não for um e-mail, você deve usá-la.
Como os endereços de e-mail geralmente podem mudar, se o endereço de e-mail for atualizado, o Hotjar tratará esse usuário como um usuário totalmente diferente. Isso o impediria de usar o User Lookup no endereço de e-mail antigo, o que pode violar seus requisitos de privacidade.
Exemplos de transmissão de atributos de usuário para o Hotjar
Identificação de clientes pagantes
Aqui está um exemplo em que queremos informar ao Hotjar quanto dinheiro alguém gastou em seu site.
hj('identify', userId, {
total_spend: 500
});
Vários atributos podem ser passados adicionando outros pares de valores-chave ao objeto. Talvez você queira que o Hotjar saiba quando o usuário se tornou um cliente pela primeira vez?
hj('identify', userId, {
total_spend: 500,
first_purchase: '2019-06-20Z'
});
Aqui estamos informando ao Hotjar que o usuário se tornou um cliente do seu serviço usando uma cadeia de datas ISO8601.
Identificação de atributos para usuários anônimos
Às vezes, é útil rastrear informações sobre os usuários do seu site, mesmo que eles ainda não sejam usuários ou clientes pagantes. Digamos que você queira rastrear a fonte de referência e a variante de teste A-B da página de destino de onde um lead em potencial chegou até você:
hj('identify', null, {
ab_test: 'variant-A',
referrer: 'facebook_paid'
});Isso seria útil se você quisesse direcionar um questionário para usuários da variante A ou somente para aqueles que chegaram até você por meio de anúncios pagos do Facebook, por exemplo.
Uso da API Identify em conformidade com a lei
A API Identify é desativada por padrão, o que facilita evitar a captura acidental de informações pessoais até que você tenha lidado adequadamente com as questões de privacidade. Ao ativar os Atributos do Usuário, você pode estar transmitindo os dados pessoais dos seus usuários finais para o Hotjar. Exigimos que você reconheça suas obrigações legais ao fazer isso e aceite o Contrato de Processamento de Dados do Hotjar.
É sua responsabilidade usar esse recurso de forma legalmente compatível, de acordo com as leis do seu país e dos países de onde seus usuários visitam. Visite nossa página de privacidade para saber mais sobre a abordagem do Hotjar em relação à privacidade do usuário. Ao usar os Atributos do Usuário, você deve estar ciente e em conformidade com os Termos de Serviço e a Política de Uso Aceitável do Hotjar.
Manuseio de solicitações de pesquisa e exclusão de usuários
É possível pesquisar e excluir os dados de um usuário usando seu ID de usuário. Leia mais sobre isso em nosso artigo "Como usar a pesquisa de usuário User Lookup".. É importante observar que, se você souber o ID de usuário e o endereço de e-mail de um usuário, deverá procurar suas informações com ambos. Essa é a única maneira de garantir que todas as informações pessoais que o Hotjar possui sobre esse usuário tenham sido pesquisadas e excluídas.
Desativação de atributos de usuário
Para evitar que outros atributos de usuário sejam enviados ao Hotjar, desative os atributos de usuário.
Enquanto os atributos de usuário estiverem ativados em seu site, se quiser evitar que eles sejam enviados no futuro, remova o código do site que os envia ao Hotjar. Depois que o código for excluído do seu site, os atributos de usuário coletados anteriormente ainda existirão, mas não serão mais atualizados ou adicionados a novos usuários do seu site.
Exclusão de atributos de usuário
Os atributos de usuário podem ser excluídos da página de gerenciamento de atributos de usuário clicando no ícone da lixeira à direita do atributo. Somente os membros da equipe com permissões de "Leitura e gravação" ou superiores podem excluir atributos de usuário.
Quando um atributo for excluído, ele desaparecerá imediatamente do aplicativo Hotjar. Entretanto, o atributo ainda é armazenado no back-end por 7 dias antes de ser excluído permanentemente. Os dados associados ao atributo são ignorados durante o período de 7 dias. Isso evita que os dados sejam enviados devido a problemas de cache.
Se desejar recriar um atributo que foi excluído, será necessário aguardar 7 dias para que o atributo possa ser recriado com êxito.
Certifique-se de remover todos os atributos de usuário excluídos de todas as chamadas de API de identificação
A exclusão de um atributo de usuário não o removerá de nenhuma sessão ou resposta existente que o contenha. O atributo só será removido da filtragem e do direcionamento. Lembre-se de remover o atributo de usuário excluído de todas as chamadas da API Identify, caso contrário, ele reaparecerá na lista.
Práticas recomendadas
Quando fazer chamadas de API para o Identify
Você deve fazer chamadas para o Identify sempre que:
- Uma página é carregada com os valores mais recentes (mesmo que eles não tenham sido alterados).
- Após uma alteração de URL em aplicativos de página única.
- Toda vez que for feita uma alteração. Por exemplo, se você quiser rastrear a última compra em uma loja, atualize esse atributo de usuário assim que a compra for feita.
Cada chamada atualizará os atributos do usuário com o Hotjar com os valores mais recentes. Quando uma sessão de gravação termina, a gravação salva os valores mais recentes no momento em que a sessão termina. Quando uma chamada é feita, mas os valores não foram atualizados, a solicitação de rede não será enviada para evitar solicitações AJAX desnecessárias.
Combinação de chamadas à API Identify com acionadores para direcionar widgets de Questionários/Feedback
Se você planeja combinar acionadores JavaScript com direcionamento de atributos de usuário para widgets de pesquisas ou de feedback, certifique-se de que a chamada do Identify tenha ocorrido antes do acionador em sua ordem de execução, levando em conta quaisquer chamadas assíncronas para outros serviços. Se o acionador for executado antes que a chamada à API Identify tenha concluído a execução, o widget Survey/Feedback não será exibido.
Enfileiramento de chamadas para a API antes do carregamento do Hotjar
Se esse script for adicionado antes do código de rastreamento do Hotjar, ocorrerá um erro.
O objeto hj() não pode ser acessado até que a tag do código de rastreamento do Hotjar tenha sido executada. Se, por algum motivo, você acessar a API do Identify antes da execução do código de rastreamento, poderá adicionar a seguinte linha de código antes de a API ser chamada:
window.hj=window.hj||function(){(hj.q=hj.q|||[]).push(arguments)};Teste de atributos de usuário
Há algumas maneiras de testar se os atributos de usuário estão sendo enviados corretamente por meio da API de identificação.
- Quando o código estiver ativo em sua página e tiver sido acionado pelo menos uma vez, você poderá visitar a página de configurações de atributos de usuário para ver se o atributo de usuário capturado pelo Hotjar está ativo em sua página.
- Você pode ativar o modo de depuração do Hotjar no navegador para ver se as chamadas de API de identificação estão sendo enviadas ao Hotjar com êxito durante sua sessão.
- Para usuários de valor nulo, você pode usar qualquer endereço de e-mail que possua para consentir em conectar o Feedback respostas por meio de uma pesquisa ou feedback. Isso permitirá que você veja quais atributos de usuário estão sendo passados para usuários não identificados, o que é especialmente útil para verificar se você não está enviando acidentalmente PII para o Hotjar. É importante observar que os usuários que não consentiram em conectar o Feedback não podem ser pesquisados dessa forma, portanto, para fins de teste, você deve configurar um widget de feedback para conceder consentimento com seu próprio endereço de e-mail.