ドキュメントのエンゲージメントデータを、サードパーティのアナリティクスプロバイダーへ自動送信します。

​
すべてのインテグレーション

Amplitude

Mixpanel

PostHog

Google Analytics 4

Google タグ マネージャー

Hightouch

Hotjar

Koala

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

​
アナリティクスの有効化

docs.json にアナリティクス用のキーを設定します。アナリティクスのインテグレーションは無料で無制限に追加できます。 docs.json の記法は以下のとおりです。接続したいプラットフォームの項目だけを含めれば十分です。
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"
    }
}

​
アナリティクスイベント

以下のイベントをアナリティクスプロバイダーに送信します。すべてのイベントは docs. 接頭辞を使用します。
Event nameDescription
docs.accordion.closeユーザーがアコーディオンを閉じたとき。
docs.accordion.openユーザーがアコーディオンを開いたとき。
docs.api_playground.requestユーザーがAPIプレイグラウンドでAPIを呼び出したとき。
docs.code_block.copyユーザーがコードブロックからコードをコピーしたとき。
docs.code_block.ask_aiユーザーがアシスタントにコードブロックの説明を依頼したとき。
docs.content.viewユーザーがページを閲覧したとき。デフォルトでページビューを追跡しないアナリティクスプロバイダーでのみ有効。
docs.feedback.thumbs_upユーザーが肯定的なフィードバックボタンをクリックしたとき。
docs.feedback.thumbs_downユーザーが否定的なフィードバックボタンをクリックしたとき。
docs.navitem.cta_clickユーザーがCTAをクリックしたとき。
docs.expandable.closeユーザーが展開コンポーネントを閉じたとき。
docs.expandable.openユーザーが展開コンポーネントを開いたとき。
docs.navitem.clickユーザーがヘッダーナビゲーション項目をクリックしたとき。
docs.footer.powered_by_mintlify_clickユーザーが「Powered by Mintlify」リンクをクリックしたとき。
docs.assistant.source_clickユーザーがチャット内の引用をクリックしたとき。
docs.assistant.suggestion_clickユーザーがチャット内の提案をクリックしたとき。
docs.assistant.thumbs_upユーザーがチャット内で肯定的なフィードバックボタンをクリックしたとき。
docs.assistant.thumbs_downユーザーがチャット内で否定的なフィードバックボタンをクリックしたとき。
docs.assistant.completedチャットセッションが完了したとき。
docs.assistant.enterユーザーがチャットを開始したとき。
docs.assistant.sharedユーザーがチャットの会話を共有したとき。
docs.search.closeユーザーが検索バーを閉じたとき。
docs.search.result_clickユーザーが検索結果をクリックしたとき。
docs.context_menu.copy_pageユーザーが現在のページをMarkdownとしてコピーしたとき。
docs.context_menu.copy_mcp_linkユーザーがホスト型のMCPサーバーのリンクをコピーしたとき。
docs.context_menu.ai_provider_clickユーザーがAIプロバイダーをクリックし、現在のページをコンテキストとして会話を作成したとき。
docs.context_menu.install_mcp_serverユーザーがコードエディタにホスト型のMCPサーバーをインストールしたとき。