diff --git a/integrations/analytics/mixpanel.mdx b/integrations/analytics/mixpanel.mdx index f4682f77f..7ce38dbcb 100644 --- a/integrations/analytics/mixpanel.mdx +++ b/integrations/analytics/mixpanel.mdx @@ -9,13 +9,21 @@ Add the following to your `docs.json` file to send analytics to Mixpanel. ```json Analytics options in docs.json "integrations": { "mixpanel": { - "projectToken": "YOUR_MIXPANEL_PROJECT_TOKEN" + "projectToken": "YOUR_MIXPANEL_PROJECT_TOKEN", + "recordSessionsPercent": 100 } } ``` Replace `YOUR_MIXPANEL_PROJECT_TOKEN` with your Mixpanel project token. You can find this in your [Mixpanel project settings](https://mixpanel.com/settings/project). +## Configuration options + +| Property | Type | Description | +| :--------------------- | :----- | :-------------------------------------------------------------------------------------------- | +| `projectToken` | string | **Required.** Your Mixpanel project token. | +| `recordSessionsPercent`| number | Percentage of user sessions to record (0-100). Session replay must be enabled in your Mixpanel project. | + ## Tracked events Mintlify automatically tracks the following user interactions: diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index 0541c8ef6..8ee685b2f 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -613,7 +613,8 @@ Analytics integrations only require public API keys, which are accessible to any "appId": "required" }, "mixpanel": { - "projectToken": "required" + "projectToken": "required", + "recordSessionsPercent": "optional (0-100)" }, "pirsch": { "id": "required" @@ -647,7 +648,8 @@ Analytics integrations only require public API keys, which are accessible to any "apiHost": "https://app.posthog.com" }, "mixpanel": { - "projectToken": "xxxxxxxxxxxxx" + "projectToken": "xxxxxxxxxxxxx", + "recordSessionsPercent": 50 } } } diff --git a/organize/settings.mdx b/organize/settings.mdx index b28df0170..0ac547cd0 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -1075,6 +1075,9 @@ This section contains the full reference for the `docs.json` file. Your Mixpanel project token. + + Percentage of user sessions to record. Session replay must be enabled in your Mixpanel project. +