Skip to content

Document recordSessionsPercent option for Mixpanel #4415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify-development wants to merge 1 commit into from
Closed

Document recordSessionsPercent option for Mixpanel #4415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion integrations/analytics/mixpanel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,21 @@
```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. |

Check warning on line 25 in integrations/analytics/mixpanel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/mixpanel.mdx#L25 

In general, use active voice instead of passive voice ('be enabled').

## Tracked events

Mintlify automatically tracks the following user interactions:
Expand Down
6 changes: 4 additions & 2 deletions integrations/analytics/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

<Card
title="Mixpanel"
href="/integrations/analytics/mixpanel"

Check warning on line 47 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L47 

Use 'Mixpanel' instead of 'mixpanel'.
horizontal
icon={
<svg
Expand Down Expand Up @@ -89,7 +89,7 @@

<Card
title="PostHog"
href="/integrations/analytics/posthog"

Check warning on line 92 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L92 

Use 'PostHog' instead of 'posthog'.
horizontal
icon={
<svg
Expand Down Expand Up @@ -613,7 +613,8 @@
"appId": "required"
},
"mixpanel": {
"projectToken": "required"
"projectToken": "required",
"recordSessionsPercent": "optional (0-100)"
},
"pirsch": {
"id": "required"
Expand Down Expand Up @@ -647,7 +648,8 @@
"apiHost": "https://app.posthog.com"
},
"mixpanel": {
"projectToken": "xxxxxxxxxxxxx"
"projectToken": "xxxxxxxxxxxxx",
"recordSessionsPercent": 50
}
}
}
Expand Down
3 changes: 3 additions & 0 deletions organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@
</ResponseField>

<ResponseField name="metadata" type="object">
Metadata configuration for documentation pages.

Check warning on line 602 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L602 

Use 'metadata' instead of 'Metadata'.

<Expandable title="Metadata">
<ResponseField name="timestamp" type="boolean">
Expand Down Expand Up @@ -1075,6 +1075,9 @@
<ResponseField name="projectToken" type="string" required>
Your Mixpanel project token.
</ResponseField>
<ResponseField name="recordSessionsPercent" type="number (0-100)">
Percentage of user sessions to record. Session replay must be enabled in your Mixpanel project.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="pirsch" type="object">
Expand Down
Loading