Instale o SDK

Identifique os usuários

Acompanhe um evento

Acompanhar atributos

Agrupar utilizadores

Deixar Feedback

SDK JavaScript

Instale o SDK

Abaixo está a tag da Specific. Copie e cole-a no código de cada página do seu site ou aplicativo web, onde você deseja que a Specific rastreie seus usuários. Cole-a imediatamente após o elemento <head>. Não adicione mais de uma tag Specific a cada página.

Certifique-se de substituir seu WORKSPACE_ID na última linha. Você pode encontrá-lo aqui na seção de Integrações.

<script type="text/javascript">
  (function(l, e, a, p) {
    if (window.Specific) return
    window.Specific = function() {
      S._queue.push(arguments)
    }
    var S = window.Specific
    S.appId = a
    S._queue = []
    a = l.createElement('script')
    a.async = 1
    a.src = e + '?id=' + S.appId
    p = l.getElementsByTagName('script')[0]
    p.parentNode.insertBefore(a, p)
  })(document, 'https://cdn.specific.app/bundle.js', 'WORKSPACE_ID')
</script>

Identifique os usuários

Isso é importante se você quiser saber quem disse o quê; caso contrário, todas as respostas permanecerão anônimas.

Quando um usuário visita uma página com o nosso SDK, ele recebe um ID de visitante único que possibilita pesquisas direcionadas. No entanto, os usuários permanecem não autenticados até que seus IDs de visitante se alinhem com os IDs de Usuário únicos no seu sistema.

Se você já estiver usando IDs no seu sistema, recomendamos sincronizar os IDs entre plataformas para garantir uma segmentação consistente e evitar a repetição de pesquisas.

Requisitos para IDs:

Único: Nenhum usuário compartilha o mesmo ID.
Mapeável: Os IDs se conectam ao seu sistema interno.
Estático: Os IDs permanecem os mesmos ao longo do tempo.

Definir ID de Usuário

Use setUserId para atribuir um identificador de usuário (até 256 caracteres) no momento do login. Esta função é segura para ser chamada várias vezes e garante a consistência da identificação do usuário entre sessões.

Specific('definirIdDoUsuario', 'ID_DO_USUARIO');

Sair

Quando um usuário sai do seu site ou produto, certifique-se de que ele também seja desconectado do nosso sistema. Isso evita que novas ações sejam atribuídas erroneamente ao usuário errado. Lembre-se de que, se usar isso para um usuário não autenticado, um novo ID será criado e contado separadamente para o seu limite de usuários.

Specific('logoutUser');

Acompanhe um Evento para acionar pesquisas

Os eventos são usados para acionar pesquisas ou direcionar usuários específicos com base nas ações deles dentro do seu produto. Ao rastrear eventos, você pode garantir que as pesquisas sejam exibidas no momento certo e para o público certo.

Tipos de Eventos

Nossa plataforma oferece suporte a dois tipos de eventos para disparar e filtrar pesquisas:

Eventos Sem Código: Estes eventos podem ser configurados por membros da equipe sem acessar a base de código, tornando-os ideais para atualizações rápidas ou experimentos. Eventos sem código podem ser ajustados posteriormente usando nossa interface intuitiva.
Eventos com Código: Estes eventos exigem que um desenvolvedor implemente o rastreamento diretamente em sua base de código. Eles são altamente personalizáveis e podem incluir propriedades adicionais para segmentação ou comportamento mais detalhado.

Configurando Eventos Sem Código

Os Eventos Sem Código podem ser configurados diretamente através da Interface de Eventos sem modificar o código do seu aplicativo. Isso permite que membros da sua equipe não técnica definam e gerenciem eventos rapidamente para ativar pesquisas.

Implementação de Eventos de Código

Para rastrear um Evento de Código, você pode usar o seguinte snippet em sua aplicação. Isso rastreia o evento em segundo plano:

Specific('evento', 'Nome do Evento');

Se você deseja que o evento dispare uma pesquisa imediatamente (por exemplo, abrir um modal após o usuário clicar em um botão), use este snippet aprimorado. Ele fornece feedback instantâneo sem esperar pela resposta do servidor:

Specific('evento', 'Nome do Evento', { loadingPlacement: 'centro', autoFocus: true });

Acompanhe Atributos para direcionar Usuários

Os atributos permitem que você alcance dois objetivos principais: obter mais contexto sobre seus usuários e direcionar as pesquisas de forma mais eficaz.

Ao adicionar dados sobre seus usuários, você pode ver quem forneceu cada resposta, tornando as conversas identificáveis em vez de anônimas.

Quando se trata de segmentação, os atributos permitem que você concentre seu foco. Por exemplo, você pode exibir pesquisas apenas para segmentos específicos de usuários, como usuários avançados ou usuários de um determinado país. Além disso, os atributos facilitam a filtragem e análise das respostas das pesquisas.

Nome, E-mail

Use setName e setEmail para atribuir o nome e o endereço de e-mail de um usuário.

Specific('setNome', 'John Doe');
Specific('setEmail', 'john@example.com');

Atributos Personalizados

Use setAttributes ou setAttribute para adicionar qualquer atributo personalizado, como o país do usuário ou se ele é um usuário avançado.

// Defina múltiplos atributos
Specific('setAttributes', {
  power_user: true,
  country: "US"
});

// Defina um atributo único
Specific('setAttribute', 'country', 'US');

Idioma

Se a interface do usuário do seu produto suporta vários idiomas, você pode pesquisar os usuários em seu idioma nativo. Use setLanguage com um código de idioma ISO 639-1 (consulte a lista de códigos de idiomas) para definir o idioma preferido do usuário.

Specific('setLanguage', 'pt');

Configurando Atributos no backend

Existem muitos casos de uso onde você precisa definir atributos a partir do backend. Você também pode fazer isso! Aqui estão exemplos para uma string, um número e um booleano.

Você pode gerar sua CHAVE_API_PESSOAL nas Preferências na seção de API e recuperar seu ID_DO_WORKSPACE na Interface de Integrações. E não se esqueça de remover os # Comentários.

curl -X POST 'https://wapi.specific.app/api/v1/user' \
-H 'authorization: PERSONAL_API_KEY' \
-H 'x-app: WORKSPACE_ID' \
-H 'Content-Type: application/json' \
-d '{
  "id": "123456789",            # Obrigatório: ID único do usuário
  "name": "John Doe",           # Opcional: Nome do usuário
  "email": "john@example.com",  # Opcional: Email do usuário
  "group": {                    # Opcional: Detalhes do grupo
    "id": "4242424242424242",   # Opcional: ID do grupo
    "name": "Acme Inc."         # Opcional: Nome do grupo
  },
  "attrs": [                    # Opcional: Atributos do usuário
    {
      "key": "company_size",    # Chave de atributo opcional
      "value": 1000             # Exemplo de valor
    },
    {
      "key": "active",          # Chave de atributo opcional
      "value": true             # Exemplo de valor
    },
    {
      "key": "subscription_plan", # Chave de atributo opcional
      "value": "Free"             # Exemplo de valor
    }
  ]
}'

Agrupar Usuários (em empresas, áreas de trabalho, etc.)

Use a função setGroup para organizar seus usuários em grupos significativos, como empresas ou espaços de trabalho (por exemplo, espaços de trabalho no Figma). Esta função atribui um usuário a um grupo específico—como um ID de Empresa ou Espaço de Trabalho—no login, garantindo um acompanhamento consistente entre sessões. Cada ID de grupo pode ter até 256 caracteres.

Principais Recomendações:

Colocação: Você pode incluir este trecho de código em qualquer lugar do seu aplicativo, embora geralmente seja adicionado próximo à função setUserId durante o cadastro ou login do usuário.
Exclusividade: Certifique-se de que GROUP_ID é um identificador único, de preferência o ID do espaço de trabalho ou da empresa no seu banco de dados.
Atributos: Inclua o nome da empresa e quaisquer atributos adicionais (por exemplo, subscription_plan, company_size) para melhorar as capacidades de filtragem e geração de relatórios.
Limitações: Um usuário pode pertencer a apenas um grupo por vez.

Agrupar usuários permite que você analise conversas, filtre relatórios e direcione pesquisas de forma mais eficaz.

Specific('setGroup', 'GROUP_ID', {
    name: 'Acme Inc.',
    attributes: {
        'subscription_plan': 'gratuito',
        'company_size': 1000,
    }
});

Configurando Atributos no backend

Se precisar definir atributos a partir do backend, você também pode fazer isso!

Você pode gerar sua CHAVE_API_PESSOAL nas Preferências na seção de API e recuperar seu ID_DO_WORKSPACE na Interface de Integrações. E não se esqueça de remover os # Comentários.

curl -X POST 'https://wapi.specific.app/api/v1/group' \
-H 'authorization: PERSONAL_API_KEY' \
-H 'x-app: WORKSPACE_ID' \
-H 'Content-Type: application/json' \
-d '{
  "id": "4242424242424242",         # Obrigatório: ID Único do Grupo
  "name": "Acme Inc.",              # Opcional: Nome do grupo
  "attrs": [                        # Opcional: Atributos do grupo
    {
      "key": "active",              # Chave de atributo opcional
      "value": true                 # Valor exemplo (grupo está ativo)
    },
    {
      "key": "company_size",        # Chave de atributo opcional
      "value": 1000                 # Valor exemplo (número de funcionários)
    },
    {
      "key": "subscription_plan",   # Chave de atributo opcional
      "value": "Gratuito"           # Valor exemplo (tipo de assinatura)
    }
  ]
}'

Você pode fazer mais usando nossa API pública. Saiba mais em nossa documentação da API.