Jamdesk Documentation logo

Provedores de análise e replay de sessão

Adicione PostHog, Mixpanel, Amplitude, Hotjar, Clarity, Fathom, Pirsch, Heap, LogRocket, Segment, Clearbit, Hightouch ou Koala com um único bloco no docs.json.

O Jamdesk carrega scripts para mais 13 provedores de análise, replay de sessão e identidade a partir do docs.json. Adicione o bloco do provedor em integrations. O Jamdesk injeta o script em todas as páginas do seu site de documentação publicado.

O Jamdesk verifica cada valor contra um formato rigoroso antes de carregar o script. Um valor no formato errado (caracteres extras, prefixo incorreto, tamanho errado) é ignorado silenciosamente. Você não recebe uma página de erro nem uma tag de script quebrada. Se um provedor não estiver carregando, copie novamente o valor do painel dele e confira com o formato abaixo.

Configurar pelo dashboard

A forma mais rápida de configurar é em Dashboard → Integrations. Escolha o cartão de um provedor e cole a chave. O Jamdesk grava o bloco do docs.json e dispara uma nova build (somente para projetos conectados ao GitHub). Use as seções abaixo para editar o docs.json diretamente ou em projetos que usam apenas a CLI.

PostHog

Análise de produto, replay de sessão e feature flags.

Formato: A chave de API do projeto começa com phc_, seguida de 8 a 64 letras ou números. O host de API opcional deve ser uma URL https://.

Encontre sua chave em Settings → Project → Project API key no PostHog.

docs.json
{
  "integrations": {
    "posthog": {
      "apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
      "apiHost": "https://us.i.posthog.com"
    }
  }
}

apiHost é opcional. O padrão é https://us.i.posthog.com. Defina-o como o host da nuvem da UE ou a URL do seu proxy reverso, caso use algum.

Mixpanel

Análise de eventos e funis.

Formato: O token do projeto tem exatamente 32 caracteres hexadecimais minúsculos (0-9, a-f).

Encontre seu token em Project Settings → Access Keys → Project Token no Mixpanel.

docs.json
{
  "integrations": {
    "mixpanel": {
      "projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
    }
  }
}

Amplitude

Análise de produto e coortes comportamentais.

Formato: A chave de API tem exatamente 32 caracteres hexadecimais minúsculos (0-9, a-f).

Encontre sua chave em Settings → Projects → seu projeto → API Key no Amplitude.

docs.json
{
  "integrations": {
    "amplitude": {
      "apiKey": "f6e5d4c3b2a1908877665544332211ff"
    }
  }
}

Hotjar

Mapas de calor e gravações de sessão.

Formato: O ID do site tem de 1 a 12 dígitos. A versão do snippet tem de 1 a 4 dígitos (geralmente 6).

Encontre o ID do site e a versão do snippet em Sites & Organizations → seu site no Hotjar.

docs.json
{
  "integrations": {
    "hotjar": {
      "hjid": "3482910",
      "hjsv": "6"
    }
  }
}

O Hotjar grava as sessões dos visitantes. Se a GDPR, a CCPA ou regulamentações semelhantes se aplicarem aos seus leitores, condicione-o ao Consentimento de cookies.

Microsoft Clarity

Mapas de calor e gravações de sessão gratuitos.

Formato: O ID do projeto tem de 4 a 32 letras ou números.

Encontre o ID do seu projeto em Settings → Overview → Project ID no Clarity.

docs.json
{
  "integrations": {
    "clarity": {
      "projectId": "qbxk2paw9m"
    }
  }
}

O Clarity grava as sessões dos visitantes. Se a GDPR, a CCPA ou regulamentações semelhantes se aplicarem aos seus leitores, condicione-o ao Consentimento de cookies.

Fathom

Análise de privacidade em primeiro lugar, sem cookies.

Formato: O ID do site tem de 4 a 16 letras ou números.

Encontre o ID do seu site em Settings → Sites → seu site no Fathom.

docs.json
{
  "integrations": {
    "fathom": {
      "siteId": "ABCD1234"
    }
  }
}

Pirsch

Análise sem cookies e focada em privacidade.

Formato: O código de identificação tem de 4 a 64 letras ou números.

Encontre seu código em Settings → Developer → Identification Code no Pirsch.

docs.json
{
  "integrations": {
    "pirsch": {
      "id": "Jd8fK2pQmZx9AeRt"
    }
  }
}

Heap

Captura automática de eventos, sem instrumentação manual.

Formato: O App ID tem de 6 a 20 dígitos.

Encontre seu App ID em Account → Manage → Projects no Heap.

docs.json
{
  "integrations": {
    "heap": {
      "appId": "1234567890"
    }
  }
}

LogRocket

Replay de sessão com logs de console e de rede.

Formato: O App ID são dois segmentos de slug separados por uma barra (org-slug/app-slug). Cada segmento tem de 2 a 64 letras minúsculas, números ou hifens.

Encontre seu App ID em Settings → Project Setup no LogRocket.

docs.json
{
  "integrations": {
    "logrocket": {
      "appId": "acme-inc/docs-site"
    }
  }
}

O LogRocket grava as sessões dos visitantes, incluindo a atividade do console e da rede. Se a GDPR, a CCPA ou regulamentações semelhantes se aplicarem aos seus leitores, condicione-o ao Consentimento de cookies.

Segment

Encaminhe os eventos de documentação para todas as ferramentas downstream a partir de uma única fonte.

Formato: A write key tem de 10 a 64 letras ou números (sem hifens nem sublinhados).

Encontre sua write key em Connections → Sources → sua fonte JS → Settings → API Keys no Segment.

docs.json
{
  "integrations": {
    "segment": {
      "key": "hcQ8wK9pXeR2mNq7"
    }
  }
}

Clearbit

Identifique e enriqueça visitantes anônimos.

Formato: A chave de API pública começa com pk_, seguida de 6 a 64 letras ou números.

docs.json
{
  "integrations": {
    "clearbit": {
      "publicApiKey": "pk_4f8a2e1c9b6d"
    }
  }
}

Hightouch

Envie eventos de documentação diretamente para o seu data warehouse.

Formato: A write key tem de 8 a 128 caracteres (letras, números, :, ., _, -). O host de API opcional tem de 4 a 64 caracteres (letras, números, ., -).

docs.json
{
  "integrations": {
    "hightouch": {
      "writeKey": "wk_prod_4f8a2e1c9b6d",
      "apiHost": "us-east-1.hightouch-events.com"
    }
  }
}

apiHost é opcional. Defina-o apenas para um endpoint de eventos Hightouch auto-hospedado ou específico de uma região.

Koala

Identifique visitantes com alta intenção de compra para vendas e marketing.

Formato: A chave de API pública começa com pk_, seguida de 6 a 64 letras ou números.

docs.json
{
  "integrations": {
    "koala": {
      "publicApiKey": "pk_7e3a9c1f6b2d"
    }
  }
}

Controle de consentimento

Todos os provedores acima respeitam integrations.cookies. Com ele definido, os scripts deles são carregados somente depois que o seu banner de consentimento registrar a aprovação. Veja Consentimento de cookies para a configuração. Sem ele, todos os scripts são carregados para todos os visitantes assim que a página abre.

Artigos relacionados

Consentimento de cookies

Condicione esses scripts ao consentimento do visitante

Google Analytics

Adicione o GA4 com um ID de medição

Provedores de suporte e chat

Widgets de chat ao vivo Intercom e Front Chat