Integrações de analytics

Integre-se a uma plataforma de analytics para rastrear eventos

Envie automaticamente dados sobre o engajamento com sua documentação para seu provedor de analytics de terceiros.

Todas as integrações

Amplitude

Mixpanel

PostHog

Google Analytics 4

Google Tag Manager

Hightouch

Hotjar

Koala

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

Habilitando analytics

Defina suas chaves de analytics em docs.json. Você pode adicionar um número ilimitado de integrações de analytics gratuitamente.

A sintaxe de docs.json está abaixo. Você só precisa incluir entradas para as plataformas que deseja conectar.

Opções de analytics em docs.json

"integrations": {
    "amplitude": {
        "apiKey": "required"
    },
    "clearbit": {
        "publicApiKey": "required"
    },
    "cookies": {
      "key": "required",
      "value": "required"
    },
    "fathom": {
        "siteId": "required"
    },
    "ga4": {
        "measurementId": "required"
    },
    "gtm": {
        "tagId": "required"
    },
    "hightouch": {
        "apiKey": "required",
        "apiHost": "optional"
    },
    "hotjar": {
        "hjid": "required",
        "hjsv": "required"
    },
    "koala": {
        "publicApiKey": "required"
    },
    "logrocket": {
        "appId": "required"
    },
    "mixpanel": {
        "projectToken": "required"
    },
    "pirsch": {
        "id": "required"
    },
    "plausible": {
        "domain": "required"
    },
    "posthog": {
        "apiKey": "required",
        "apiHost": "optional"
    },
    "segment": {
      "key": "required"
    },
    "telemetry": {
      "enabled": "boolean"
    }
}

Eventos de analytics

Enviamos os seguintes eventos para o seu provedor de analytics. Todos os eventos usam o prefixo docs..

Nome do evento	Descrição
docs.accordion.close	Quando um usuário fecha um acordeão.
docs.accordion.open	Quando um usuário abre um acordeão.
docs.api_playground.request	Quando um usuário faz uma chamada de API no playground de API.
docs.code_block.copy	Quando um usuário copia código de um bloco de código.
docs.code_block.ask_ai	Quando um usuário pede ao Assistente para explicar um bloco de código.
docs.content.view	Quando um usuário visualiza uma página. Disponível apenas para provedores de analytics que não rastreiam visualizações de página por padrão.
docs.feedback.thumbs_up	Quando um usuário clica no botão de feedback positivo.
docs.feedback.thumbs_down	Quando um usuário clica no botão de feedback negativo.
docs.navitem.cta_click	Quando um usuário clica em um call to action.
docs.expandable.close	Quando um usuário fecha um elemento expansível.
docs.expandable.open	Quando um usuário abre um elemento expansível.
docs.navitem.click	Quando um usuário clica em um item de navegação do cabeçalho.
docs.footer.powered_by_mintlify_click	Quando um usuário clica no link “Powered by Mintlify”.
docs.assistant.source_click	Quando um usuário clica em uma citação em um chat.
docs.assistant.suggestion_click	Quando um usuário clica em uma sugestão em um chat.
docs.assistant.thumbs_up	Quando um usuário clica no botão de feedback positivo em um chat.
docs.assistant.thumbs_down	Quando um usuário clica no botão de feedback negativo em um chat.
docs.assistant.completed	Quando uma sessão de chat é concluída.
docs.assistant.enter	Quando um usuário inicia um chat.
docs.assistant.shared	Quando um usuário compartilha uma conversa de chat.
docs.search.close	Quando um usuário fecha a barra de busca.
docs.search.result_click	Quando um usuário clica em um resultado de busca.
docs.context_menu.copy_page	Quando um usuário copia a página atual como Markdown.
docs.context_menu.copy_mcp_link	Quando um usuário copia o link do servidor MCP hospedado.
docs.context_menu.ai_provider_click	Quando um usuário clica em um provedor de IA e cria uma conversa com a página atual como contexto.
docs.context_menu.install_mcp_server	Quando um usuário instala o servidor MCP hospedado em editores de código.