Skip to content

Commit

Permalink
Merge branch 'main' into yeeching-update-funnel-video-url
Browse files Browse the repository at this point in the history
  • Loading branch information
saminmadani authored May 10, 2024
2 parents 6f931b8 + a40dc73 commit 8009234
Show file tree
Hide file tree
Showing 17 changed files with 316 additions and 29 deletions.
42 changes: 21 additions & 21 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@
"nextra-theme-docs": "latest",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"sass": "^1.74.1",
"sass": "^1.77.0",
"sharp": "^0.32.6"
},
"devDependencies": {
"@redocly/openapi-cli": "1.0.0-beta.16",
"@types/mixpanel": "^2.14.8",
"@types/node": "20.12.5",
"@types/node": "20.12.8",
"autoprefixer": "^10.4.19",
"postcss": "^8.4.38",
"rdme": "8.6.6",
"tailwindcss": "^3.4.3",
"typescript": "^5.4.4",
"typescript": "^5.4.5",
"yaml": "2.4.1"
}
}
27 changes: 27 additions & 0 deletions pages/changelogs/2024-05-09-column-charts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Column Chart Visualization"
slug: "changelog-2024-05-09-column-chart-visualization"
hidden: false
createdAt: "2024-05-09T18:59:02.165Z"
updatedAt: "2024-05-09T18:59:02.165Z"
date: "2024-05-09"
---
![column chart](/changelog/column-chart.png)

<div style={{position: 'relative', paddingBottom: '64.90384615384616%', height: 0}}>
<iframe src="https://www.loom.com/embed/cf7bfc28090d4e14864ee7e7d4cacc29"
frameBorder="0"
webkitallowfullscreen="true" mozallowfullscreen="true" allowFullScreen
style={{position: 'absolute', 'top': 0, 'left': 0, 'width': '100%', 'height': '100%'}}>
</iframe>
</div>

You can now view your time series as a column or stacked column chart in Insights report. You can use Column charts to:

- Visualize and compare customer segments by behaviors or engagement over time
- Compare product sales performance across different regions or customer types
- Compare funnels or retention metrics
- Visualize monthly new sign-ups, active users, and churn rates
- Present financial trends and health over time

Column charts give you another way to visualize your data. Column charts tend to be better when visualizing data over shorter time frames.
20 changes: 20 additions & 0 deletions pages/changelogs/2024-05-09-home.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Home"
slug: "changelog-2024-05-09-home.mdx"
hidden: false
createdAt: "2024-05-09T16:50:45.397Z"
updatedAt: "2024-05-09T16:50:45.397Z"
date: "2024-05-09"
---

Home is the new landing experience in Mixpanel. It’s for you to jump back into your workflows and get a glimpse into what’s happening across your product and your project in Mixpanel.

The main sections of Home includes:

- **Your Recents**: most recently viewed reports and boards by you
- **Your Product**: this section is default populated with the top insights reports in your project, you can customize and change which insight report you’d like to display on Home
- **Top Boards**: the most popular boards in your project
- **Suggested Creators**: people in Mixpanel who are building boards and reports that we recommend checking out
- **Recent Users**: a list of recently seen users on your product
- **New Events**: a list of newly tracked events in your project
- **Resources**: a list of resources that are also available in the top navigation
2 changes: 1 addition & 1 deletion pages/docs/data-governance/data-clean-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ We limit access to Data Deletion in these scenarios:
- Your Mixpanel role is not Owner or Admin
- Your data extends beyond the past 90 days
- Your event volumes are > 5 billion events per month, any month over the trailing 3 months
- You have made 10 deletes over the past calendar month
- Your project has not had more than 10 deletes over the past calendar month

### How to use

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/data-structure/property-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Mixpanel supports five data types for properties: String, Numeric, Boolean, Date

## Object and List of Objects Data Types

Mixpanel also supports object and [list of objects](https://docs-git-kurbycchua-update-property-reference-mixpanel.vercel.app/docs/features/advanced#list-of-objects-property-support) data types in a limited capacity. These are typically for very specific use cases such as in e-commerce (eg Cart Items, Search Filters). It is highly encouraged that you use the five primary data types as they are fully supported in the Mixpanel UI.
Mixpanel also supports object and [list of objects](/docs/features/advanced#list-of-objects-property-support) data types in a limited capacity. These are typically for very specific use cases such as in e-commerce (eg Cart Items, Search Filters). It is highly encouraged that you use the five primary data types as they are fully supported in the Mixpanel UI.

### Object

Expand Down
3 changes: 2 additions & 1 deletion pages/docs/features/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"custom-events": "Custom Events",
"custom-properties": "Custom Properties",
"saved-behaviors": "Saved Behaviors",
"sessions": "Sessions",
"session-replay": "Session Replay",
"sessions": "Sessions",
"spark": "Spark",
"advanced": "Advanced"
}
176 changes: 176 additions & 0 deletions pages/docs/features/session-replay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
# Session Replay

## Overview

Mixpanel Session Replay is the fastest way to understand the whole picture about your customers and make better product decisions, by combining quantitative and qualitative user insights.

When digging into customer journeys in Mixpanel’s analytics, you can understand “where do customers drop-off?” And now, Mixpanel Session Replay enables you to quickly follow-up with, “why do customers drop off?”

## Availability

Currently, Session Replay is currently in invite-only beta access for:

- customers on our [Enterprise plan](https://www.notion.so/Session-Replay-Docs-v1-c32c9817ec1b49798d1ca7d1ccc5880c?pvs=21)
- projects without [EU Data Residency](https://docs.mixpanel.com/docs/privacy/eu-residency) enabled

You can join the waitlist for beta access [here](https://mixpanel.com/m/session-replay-beta/).

For any questions about Session Replay or beta access, please reach out to your Account Manager.

## **Using Session Replay**

Session Replay can be accessed in two places:

1. From User Profile page
2. From Mixpanel reports

**From User Profile page**

In any user’s profile page, Click the ‘View Replays’ button to watch replays from that user. From here, you will be taken to our Replay Player.

![replayProfileEntry](/replayProfileEntryPoint.png)

**From Mixpanel reports**

Click any point on a chart for Event and Funnel metrics, and select ‘View Replays’ to view replays that show that event being fired. From here, you will be taken to our Replay Player.

![replayReportEntry](/replayReportEntryPoint.png)

*Note: reports entry point is currently supported for Event and Funnel metrics only.*

## **Replay Player**

![replayHeroImage](/replayHeroImage.png)

The Replay Player allows you to watch replays, as well as:

- Expand the player to full-screen
- Copy a URL to share with your teammates
- Change the playback speed
- Automatically skip periods of the replay where user is inactive

The Replay Feed on the left of the player also allows you to:

- sort replays by recency
- search for replays by user's name / email, replay date, or user ID

## **Privacy**

Our Session Replay Beta Service Addendum can be found [here](https://mixpanel.com/legal/session-replay-beta-service-addendum/).

## **FAQ**

### **Is Session Replay available for mobile?**

To start, Session Replay is available only for web-based applications (including mobile web). We hope to offer mobile support in the near future.

### Can I prevent Session Replay from recording sensitive content?

By default, all on-screen text elements are masked in replays. Additionally, you can customize how you initialize our SDK to fully control (1) where to record and (2) whom to record. For more details, please see our [implementation docs](https://docs-k17v3wqal-mixpanel.vercel.app/docs/tracking-methods/sdks/javascript#session-replay-beta).

### How long are replays stored?

30 days.

### Does Session Replay work on projects with EU Data Residency enabled?

Not currently, but we plan to add support soon.

### How soon are Replays available for viewing after a session begins?

There is about a ~1 minute delay between when recordings are captured and when they appear in Mixpanel.

---
<br>

## Appendix: Session Replay Privacy Controls
**Last updated May 9th, 2024**

### Introduction

Mixpanel offers a privacy-first approach to Session Replay, including features such as data masking. Mixpanel’s Session Replay privacy controls were designed to assist customers in protecting end user privacy.

Data privacy regulations are rapidly evolving and vary considerably across states and countries. A consistent requirement across many data privacy regulations for website operators is disclosing to end users that their personal information is being collected, often in a privacy notice. Before implementing Session Replay on your website, a best practice is to review your privacy notice with legal counsel to ensure it remains accurate and compliant with data privacy laws.

### How does Session Replay work?

Session Replay captures the Document Object Model (DOM) structure and changes to it. Mixpanel then reconstructs the web page, applying recorded events at the time an end user completed them. Within Mixpanel’s platform, you can view a reconstruction of your end user’s screen as they navigate your website. However, Session Replay is not a video recording of your end user’s screen and end user actions are not literally video-recorded.

### How does masking work? What are the high-level technical details?

Masked data is suppressed client-side, meaning it is not collected in its original form by Mixpanel’s SDK, and the data is not stored on Mixpanel servers. Masked data appears in Mixpanel as [****].

### Configuring Privacy Controls

Mixpanel offers its customers a range of privacy controls to limit the data captured by Session Replay, which are summarized in the table below and detailed further on this page.

| Element | Description | Mask Text Mode (Mixpanel’s Default) | Mask User Input Mode |
| --- | --- | --- | --- |
| Input | Textareas, select | Masked (cannot be unmasked) | Masked (cannot be unmasked) |
| text | Non-input text | Masked (cannot be unmasked) | Unmasked, with the ability to mask specific text elements |
| Non-text elements | Video and image elements | Ingested by default (not masked) with the ability to block specific non-text elements | Ingested by default (not masked) with the ability to block specific non-text elements |

### Mask Text Mode (Mixpanel’s Session Replay default privacy setting)

By default, Mixpanel attempts to mask all HTML text and user input text when you enable Session Replay. This masked content on your webpage is replaced with [****].

Here is an example of what “Mask Text Mode” could look like:

![replayMaskTextMode](/replayMaskTextMode.png)

### Mask User Input Mode

Mixpanel empowers its customers to decide to record all non-input text as-is, while continuing to mask input text. Inputs are replaced with [****].

`mixpanel.init(YOUR_PROJECT_TOKEN, {record_mask_text_selector: ''})`

Here is an example of what “Mask User Input Mode” could look like:

![replayMaskInputMode](/replayMaskInputMode.png)

With the goal of offering a privacy-first product, Mixpanel’s Session Replay cannot be configured to capture input form fields such as textareas.

### Mask specific elements

You can tag the privacy level of an individual HTML element using one the following methods:

1. For masking text contents, add the class name “.rr-mask”
2. To mask the entire contents of an element, add the class name “.rr-block”

The example below demonstrates how you can override certain elements in your HTML to customize your masking:

`<div class="text.rr-mask">This text is masked!</div>`

`<img src="https://image.com" class="rr-block"/>`


### Other Elements (e.g., images, video)

If you would like to block Mixpanel’s Session Replay from capturing video, images, or other non-text elements, you should add the CSS class name “.rr-block” to elements that should not be captured. This will cause the element's contents to no longer be captured. In subsequent playback, this element will be rendered with a placeholder element (e.g., an empty box of similar size).

### Disabling replay collection

Once enabled, Session Replay runs on your site until either:

- The user leaves your site
- You call `mixpanel.stop_session_recording()`

Call mixpanel.stop_session_recording() before a user navigates to a restricted area of your site to disable replay collection while the user is in that area.

To restart replay collection, call `mixpanel.start_session_recording()` to re-add the plugin.

### User Opt-Out

Mixpanel’s Session Replay follows Mixpanel’s [standard SDK opt-out setting](https://docs.mixpanel.com/docs/privacy/end-user-data-management#opt-out-users).

### Data Deletion

Deletion requests for Session Replay use Mixpanel’s standard end user management process for events documented [here](https://docs.mixpanel.com/docs/privacy/end-user-data-management).

### Data Retention

Mixpanel retains Session Replays for 30 days from the date the Session Replay is ingested and becomes available for viewing within Mixpanel.

### EU Data Residency

Session Replay is not currently available to Mixpanel customers who use the EU data center. This functionality is coming soon.
6 changes: 4 additions & 2 deletions pages/docs/migration/amplitude.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,12 @@ This service will use your provided credentials to export Amplitude data, transf

[Watch the demo tutorial](https://www.loom.com/share/f947d42db01541a0b74953461e3c6cc0?sid=43c1ef52-d008-4b6d-9015-afa14b05901c) for more in-depth instructions on how to use the migration service.

Note:
* Any events ingested via this method in the current month will count toward your plan. We recommend testing this while on a Free plan first.
Notes:
* Any events ingested via this method in the current month will count toward your plan. We recommend testing this while on a Free plan first. You may also pass a `"DRY_RUN" : true` param in the JSON which will show you how many events will be migrated.
* If you are using Mixpanel or Amplitude's EU data residency, pass `"REGION": "EU"` with your request.
* This migration service is in beta -- if you have questions or run into issues, please reach out to us [here](mailto:amplitude-migration@mixpanel.com).


### Data Warehouse Connectors
If you have access to your Amplitude data in your data warehouse, the most scalable way to bring this historical data into Mixpanel is by using our warehouse connector. At a high-level, the migration consists of 3 steps:
1. Set up a new Mixpanel project which is on [Simplified ID Merge system](/docs/tracking-methods/id-management/identifying-users#simplified-vs-original-id-merge).
Expand Down
2 changes: 2 additions & 0 deletions pages/docs/reports/insights.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ Insights feature multiple visualizations to help you view the query results in t
- Metric time-segmented
- Line chart
- Stacked line chart
- Column chart
- Stacked Column chart

### Rename an Event within a Report

Expand Down
Loading

0 comments on commit 8009234

Please sign in to comment.