Provedores de análise e replay
Adicione PostHog, Mixpanel, Amplitude, Hotjar, Clarity, Fathom, Pirsch, Heap, LogRocket, Segment, Clearbit, Hightouch ou Koala com um bloco em docs.json.
O Jamdesk carrega scripts de 13 provedores adicionais de análise, replay de sessões e identidade diretamente do docs.json. Adicione o bloco do provedor em integrations, e o Jamdesk injeta o script em todas as páginas do seu site de documentação publicado.
Cada valor é verificado em relação a um formato estrito antes que o Jamdesk carregue o script. Um valor no formato incorreto (caracteres extras, prefixo incorreto ou comprimento inválido) é ignorado silenciosamente e nunca renderizado — sem página de erro nem tag de script quebrada. Se um provedor não estiver carregando, copie novamente o valor do dashboard dele e verifique-o em relação ao formato abaixo.
Configurar pelo dashboard
A maneira mais rápida de configurar qualquer um desses provedores: Dashboard → Integrations. Escolha o card de um provedor, cole a chave, e o Jamdesk confirma o bloco de docs.json por você e aciona um novo build (somente em projetos conectados ao GitHub). As seções abaixo são para editar o docs.json diretamente ou para projetos que usam apenas a CLI.
PostHog
Análise de produto, replay de sessões e sinalizadores de recursos.
Formato: A chave de API do projeto começa com phc_, seguida por 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.
{
"integrations": {
"posthog": {
"apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
"apiHost": "https://us.i.posthog.com"
}
}
}apiHost é opcional e tem como padrão https://us.i.posthog.com. Defina-o como o host da sua nuvem da UE ou como a URL do proxy reverso, se você usar um.
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.
{
"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 → your project → API Key, no Amplitude.
{
"integrations": {
"amplitude": {
"apiKey": "f6e5d4c3b2a1908877665544332211ff"
}
}
}Hotjar
Mapas de calor e gravações de sessões.
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 ambos em Sites & Organizations → your site, no Hotjar.
{
"integrations": {
"hotjar": {
"hjid": "3482910",
"hjsv": "6"
}
}
}O Hotjar grava as sessões dos visitantes. Se o GDPR, a CCPA ou regulamentações semelhantes se aplicarem aos seus leitores, coloque-o atrás do Consentimento de cookies.
Microsoft Clarity
Mapas de calor e gravações de sessões 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.
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}O Clarity grava as sessões dos visitantes. Se o GDPR, a CCPA ou regulamentações semelhantes se aplicarem aos seus leitores, coloque-o atrás do Consentimento de cookies.
Fathom
Análise com foco em privacidade e 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 → your site, no Fathom.
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
Análise sem cookies e com foco 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.
{
"integrations": {
"pirsch": {
"id": "Jd8fK2pQmZx9AeRt"
}
}
}Heap
Captura automática de eventos, sem instrumentação manual.
Formato: O ID do app tem de 6 a 20 dígitos.
Encontre o ID do seu app em Account → Manage → Projects, no Heap.
{
"integrations": {
"heap": {
"appId": "1234567890"
}
}
}LogRocket
Replay de sessões com logs do console e da rede.
Formato: O ID do app consiste em dois segmentos de slug separados por uma barra — org-slug/app-slug — cada um com 2 a 64 letras minúsculas, números ou hífens.
Encontre o ID do seu app em Settings → Project Setup, no LogRocket.
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}O LogRocket grava as sessões dos visitantes, incluindo a atividade do console e da rede. Se o GDPR, a CCPA ou regulamentações semelhantes se aplicarem aos seus leitores, coloque-o atrás do Consentimento de cookies.
Segment
Encaminhe eventos da documentação para todas as ferramentas downstream a partir de uma única fonte.
Formato: A chave de gravação tem de 10 a 64 letras ou números (sem hífens nem sublinhados).
Encontre sua chave de gravação em Connections → Sources → your JS source → Settings → API Keys, no Segment.
{
"integrations": {
"segment": {
"key": "hcQ8wK9pXeR2mNq7"
}
}
}Clearbit
Identifique e enriqueça visitantes anônimos.
Formato: A chave de API pública começa com pk_, seguida por 6 a 64 letras ou números.
{
"integrations": {
"clearbit": {
"publicApiKey": "pk_4f8a2e1c9b6d"
}
}
}Hightouch
Envie eventos da documentação diretamente para o seu data warehouse.
Formato: A chave de gravação tem de ter de 8 a 128 caracteres (letras, números, :, ., _, -). O host de API opcional tem de ter de 4 a 64 caracteres (letras, números, ., -).
{
"integrations": {
"hightouch": {
"writeKey": "wk_prod_4f8a2e1c9b6d",
"apiHost": "us-east-1.hightouch-events.com"
}
}
}apiHost é opcional — necessário apenas para um endpoint de eventos do Hightouch hospedado por você ou específico de uma região.
Koala
Identifique visitantes com alta intenção para vendas e marketing.
Formato: A chave de API pública começa com pk_, seguida por 6 a 64 letras ou números.
{
"integrations": {
"koala": {
"publicApiKey": "pk_7e3a9c1f6b2d"
}
}
}Controle de consentimento
Todos os 13 provedores acima respeitam integrations.cookies. Quando essa opção está definida, nenhum dos scripts é carregado até que seu banner de consentimento registre a aprovação — consulte Consentimento de cookies para ver a configuração completa. Sem essa opção, todos os scripts são carregados para cada visitante no carregamento da página.