Jamdesk Documentation logo

Integração do Plausible Analytics

Adicione o Plausible Analytics, uma alternativa leve e sem cookies ao Google Analytics, ao seu site de documentação para medir o tráfego com privacidade.

Adicione o Plausible Analytics ao seu site de documentação para obter dados de tráfego sem cookies nem rastreamento entre sites.

O Plausible é open source e tem menos de 1 KB. Na maioria das jurisdições, não é necessário um banner de consentimento de cookies para ele.

Se você precisar de controle de consentimento (ou também usar GA, GTM ou Crisp), consulte Consentimento de cookies.

Escolha uma de duas configurações:

ConfiguraçãoUse quandoCampo
PadrãoVocê está no plano gratuito do Plausible ou em um plano pago sem necessidade de proxydomain
Script de proxyVocê está em um plano pago e quer contornar bloqueadores de anúnciosscriptUrl

Configuração padrão (domain)

A maioria dos sites usa esta configuração. Registre seu site no Plausible e informe o domínio.

Cadastre-se no Plausible

Crie uma conta em Plausible Analytics e adicione o domínio do seu site de documentação (por exemplo, docs.example.com).

Adicione o domínio ao docs.json

docs.json
{
  "name": "My Docs",
  "integrations": {
    "plausible": {
      "domain": "docs.example.com"
    }
  }
}

Use exatamente o domínio que você registrou: docs.example.com, não www.docs.example.com.

Servidor auto-hospedado

Se você executar a Community Edition, adicione o campo server. Ele aponta o script e a API de eventos para a sua instância:

docs.json
{
  "name": "My Docs",
  "integrations": {
    "plausible": {
      "domain": "docs.example.com",
      "server": "https://analytics.example.com"
    }
  }
}

server funciona apenas com domain. Scripts de proxy gerenciam o próprio roteamento.

Configuração do script proxy (scriptUrl)

Os planos pagos do Plausible oferecem scripts de proxy com um nome de arquivo exclusivo (como pa-XXXXX.js). Eles contornam a maioria dos bloqueadores de anúncios, pois a URL do script não corresponde às listas de filtros comuns.

Obtenha a URL do seu script proxy

Nas configurações do seu site no Plausible, localize a seção de script de proxy e copie a URL completa. Ela tem este formato: https://plausible.io/js/pa-XXXXX.js.

Adicione a URL do script ao docs.json

docs.json
{
  "name": "My Docs",
  "integrations": {
    "plausible": {
      "scriptUrl": "https://plausible.io/js/pa-XXXXX.js"
    }
  }
}

Não inclua domain nem server. O ID do script já identifica o seu site. A CDN do Plausible roteia as requisições internamente.

Verifique a instalação

Confirme que os dados estão chegando:

  1. Acione um novo build da sua documentação
  2. Acesse seu site de documentação publicado
  3. Verifique seu painel do Plausible. Sua visita deve aparecer em poucos segundos.
  4. Ou abra as DevTools, vá até a aba Network e procure uma requisição para plausible.io/js/script.js (padrão) ou para o seu script pa-XXXXX.js (proxy)

O Plausible mostra os dados em tempo real, sem o período de espera do Google Analytics.

Referência de configuração

CampoTipoObrigatórioDescrição
domainstringUm de domain ou scriptUrlO domínio do seu site, conforme registrado no Plausible. Usado como atributo data-domain na tag do script.
scriptUrlstringUm de domain ou scriptUrlURL completa de um script de proxy pago do Plausible (pa-XXXXX.js). A identidade do site está incorporada ao script. Não é necessário informar um domínio.
serverstringNãoURL de um servidor Plausible self-hosted. Usado apenas com domain, não com scriptUrl.

Solução de problemas

A causa mais comum é o domínio. Ele deve corresponder exatamente ao que você registrou no Plausible (docs.example.com, não www.docs.example.com).

Se o domínio estiver correto:

  1. Gere um novo build da documentação. As alterações de configuração só entram em vigor após um novo build.
  2. Verifique bloqueadores de anúncios. Algumas extensões de navegador bloqueiam scripts de análise, incluindo o do Plausible. Se for o caso, mude para a configuração do script de proxy.
  3. Inspecione o código-fonte da página em busca de uma tag <script> com data-domain (padrão) ou com o nome de arquivo pa-XXXXX.js (proxy). Se ela não estiver lá, a configuração não foi aplicada.

Registre o domínio que seus leitores acessam. Se a documentação estiver em docs.example.com, use esse valor como domain, e não o seu domínio raiz.

Mude para a configuração do script de proxy. O nome de arquivo exclusivo contorna a maioria das listas de filtros de bloqueadores. O self-hosting também contorna bloqueadores, pois o script é carregado a partir do seu próprio domínio.

Use domain se você estiver no plano gratuito ou não se preocupar com bloqueadores de anúncios. Use scriptUrl se estiver em um plano pago e quiser a máxima cobertura de rastreamento. Não defina os dois.

Artigos relacionados

Google Analytics

Adicione o rastreamento do GA4 à sua documentação

Análise do projeto

Veja a análise integrada do Jamdesk