diff --git a/pages/docs/data-structure/group-analytics.mdx b/pages/docs/data-structure/group-analytics.mdx index 8cacb8ea0c..da1dc1abe3 100644 --- a/pages/docs/data-structure/group-analytics.mdx +++ b/pages/docs/data-structure/group-analytics.mdx @@ -73,19 +73,24 @@ To access a group profile: ### Change the Group Identifier in a Report -To change the identifier in a report: +By default, Metrics aggregates at the user-level. To change the identifier used for aggregation in a metric: -1. Go to a report. +1. Go to a report +2. Click the “Users” dropdown within the Metric +3. Select a Group. The report will now display results grouped by the newly selected group identifier. -2. Click the **Analyze Uniques by** dropdown above the query builder. +![](/saved_behavior_group_identifier.png) + +When your [Insights report](/docs/reports/insights) includes multiple Metrics, you can individually toggle the identifier for each one. + +For example, you can create an Insights report that shows Signups by unique Users and by unique Companies. -![/Screen_Shot_2022-06-22_at_5.45.29_PM.png](/Screen_Shot_2022-06-22_at_5.45.29_PM.png) +![](/saved-metrics-and-behaviors11.png) -3. Select the group identifier. +Similarly, you can build a report that displays Conversion Rates per User and per Company. -![/Screen_Shot_2022-06-22_at_5.46.39_PM.png](/Screen_Shot_2022-06-22_at_5.46.39_PM.png) +![](/saved-metrics-and-behaviors12.png) -4. The report will now display results grouped by the newly selected group identifier. ### B2B Company Analytics diff --git a/pages/docs/features.mdx b/pages/docs/features.mdx index 219642221b..0487fe480e 100644 --- a/pages/docs/features.mdx +++ b/pages/docs/features.mdx @@ -9,7 +9,7 @@ import { Cards } from 'nextra/components' - + diff --git a/pages/docs/features/_meta.ts b/pages/docs/features/_meta.ts index 77441e3d65..5866618cb9 100644 --- a/pages/docs/features/_meta.ts +++ b/pages/docs/features/_meta.ts @@ -5,7 +5,8 @@ export default { "chart-customization": "Chart Customization", "custom-events": "Custom Events", "custom-properties": "Custom Properties", - "saved-behaviors": "Saved Behaviors", + "mcp": "MCP Integration", + "saved-metrics-and-behaviors": "Saved Metrics & Behaviors", "sessions": "Sessions", "spark": "Spark", "advanced": "Advanced" diff --git a/pages/docs/features/custom-events.md b/pages/docs/features/custom-events.md index d7665f557e..f062ab8191 100644 --- a/pages/docs/features/custom-events.md +++ b/pages/docs/features/custom-events.md @@ -13,10 +13,10 @@ You can create a custom event containing "Ad Conversion" and "Ad Impression," an ## Create a Custom Event -![image](/create-custom-event.png) +![image](/custom_event_qb.png) -1. Expand the Event dropdown in either an Insights, Funnels or Retention report. -2. Select the plus button to the right of the search bar. +1. Open the Metrics menu by clicking "Select Metrics" in an Insights report, or clicking "Select Step/Events" in the Funnels/Retention/Flows report. +2. Select "Create New", then choose "Custom Event" in the right column. 3. Select the events and properties you’d like to include. 4. Name your custom event, and click **Save**. @@ -43,3 +43,13 @@ A custom event will be private to the user who created it until it is shared wit ![image](https://github.com/user-attachments/assets/277ac882-4ef0-4251-bb1e-107ed38f4f27) ![image](https://github.com/user-attachments/assets/6d84dbf7-7bba-45fd-ba25-44e0772752d8) + +## Custom Events versus Simple Behaviors + +Custom Events and [Simple Behaviors](/docs/features/saved-metrics-and-behaviors#simple-behaviors) are similar in that both allow you to combine multiple events for analysis. However, they serve different purposes. Simple Behaviors are designed for quick editing and reuse within the query builder in the Insights report. In contrast, Custom Events offer greater flexibility, which can be used across various parts of Mixpanel, including cohort definitions, Funnels, and can also be included as events within a Simple Behavior. + + +As a best practice, follow the guidelines below to determine whether to use Simple Behaviors or Custom Events: + +- Use **Simple Behaviors** if you want to create a definition that can be easily viewed and modified from the query builder in Insights reports +- Use **Custom Events** if you need to need to create a virtual event that can be used everywhere in Mixpanel (e.g. inside a cohort definition, Funnels, Flows, or Retention) diff --git a/pages/docs/features/saved-behaviors.mdx b/pages/docs/features/saved-behaviors.mdx deleted file mode 100644 index f6113f4b0d..0000000000 --- a/pages/docs/features/saved-behaviors.mdx +++ /dev/null @@ -1,59 +0,0 @@ -import { Callout } from 'nextra/components' - -# Saved Behaviors: Reuse Funnels or Retention behavior definition in other reports - - - Users on an Enterprise or Growth plan can use Saved Behaviors. See our [pricing page](https://mixpanel.com/pricing/) for more details. - - -## Overview - -A saved behavior is a custom funnel or retention behavior definition that you can save and reuse. When saving a behavior you specify all of the steps as well as any filter that pertain to any of the steps, as well as the conversion criteria. As a reminder of [data hierarchy](/docs/reports#behaviors), a saved behavior is not a metric and does not include the measurement. - -You can use a saved behavior to centralize on key user flows in your product, and to standardize everyone on using the same definitions. For example, you have a 5 step sign up funnel. You can use a saved funnel behavior such that one team is working on the conversion rate between step 2 to 3, another team is focusing on steps 3 to 4, and yet another team can be working on reducing the time to convert on the same funnel. Then, if there is a change to the funnel behavior definition, all teams are still using the same funnel. - -## Create a Saved Behavior - -Once you are happy with the definition of a funnel or retention behavior, you can select the "Save as New" button at the bottom of the behavior. This will prompt you change the name if you'd like, add a description, and optionally choose to share the definition, so other members in your organization can also use it. - -![save](/saved-behavior-save.png) - -## Editing a Saved Behavior - -When editing a saved behavior, you'll have the option to save the existing changes. There are 3 options that exist. - -![update](/saved-behavior-update.png) - -- **Save for Everyone**: This will update the definition of the behavior for yourself, as well as in any report that is using the saved behavior. In this way, all usages of the behavior can stay in sync and there won't be mismatches across reports. -- **Save as New**: In case a new behavior needs to be saved, you can select this option to save an entirely separate behavior. -- **Reset**: Updates the behavior and reverts it back to the previously saved state. This is useful in exploratory cases where you don't want to save the definition. - -## Loading a Saved Behavior - -In Insights report, you can press "+ Metrics" and select "Funnels" or "Retention", where you'll be prompted initially to load an existing behavior. Here you can select a behavior to load or press "Create" to start building a new behavior. - -You can press the name of a behavior to open the menu to load an existing behavior. This can be done from Insights, Funnels or Retention. - -![lexicon](/saved-behavior-load.png) - -## See all Saved Behaviors - -To view, all saved behaviors, navigate to [Lexicon](/docs/data-governance/lexicon). -You can edit and delete saved behaviors from Lexicon. - -![image](https://github.com/mixpanel/docs/assets/2077899/efc4b36e-d8d9-4699-8a48-98b793532b20) - -In Lexicon, click on the **Behaviors** tab. -Here you can see a list of all the saved behaviors in the project. - -Click on the **name** of the behavior to edit its details. - -![details](/saved-behavior-details.png) - -Here you can also modify details of the behavior, including sharing, as well as see the behavior in a report. - -![lexicon](/saved-behavior-lexicon.png) - -## Delete a Saved Behavior - -To delete a saved behavior, check the **box** beside the title of all the saved behaviors you want to delete in Lexicon, then click the **delete** button at the top of the list. diff --git a/pages/docs/features/saved-metrics-and-behaviors.mdx b/pages/docs/features/saved-metrics-and-behaviors.mdx new file mode 100644 index 0000000000..22313cfc66 --- /dev/null +++ b/pages/docs/features/saved-metrics-and-behaviors.mdx @@ -0,0 +1,134 @@ +import { Callout } from 'nextra/components' + +# Saved Metrics and Behaviors + +## Overview + +Saved Metrics and Behaviors allow you to define and standardize key measurements and user actions across your product/business. By saving these definitions, you ensure consistency, reusability, and accuracy across your reporting and analysis. + +![](/saved-metrics-and-behaviors1.png) + +## Saved Metrics + +**Saved Metrics** are standardized definitions for your organization's KPIs. They quantify the performance, progress, or success of various aspects of your product/business. Each saved metric is a measurement of an event, behavior, user cohort, or profile. + +**Example:** Create a saved metric for your Signup Conversion Rate to consistently track how effectively users complete your signup process. + +## Saved Behaviors + +**Saved Behaviors** are reusable definitions of specific user actions that represent a meaningful user journey or experience. + +**Example:** If your signup process involves multiple steps, you can define this entire sequence as a "Signup Funnel" saved behavior. + +Behaviors fall into one of three types: **Simple**, **Funnel**, or **Retention**. + +### Simple Behaviors + +**Simple Behaviors** are an "or" list of one or more events. These are useful when you have multiple events that need to be looked at together to measure a specific behavior. For example, below is a simple behavior for all product page interactions: + +![](/saved-metrics-and-behaviors8.png) + +**Simple Behaviors versus Custom Events** + +Simple Behaviors and [Custom Events](/docs/features/custom-events) are similar in that both allow you to combine multiple events for analysis. As a best practice, follow the guidelines below to determine whether to use Simple Behaviors or Custom Events: + +- Use **Simple Behaviors** if you want to create a definition that can be easily viewed and modified from the query builder in Insights reports +- Use **Custom Events** if you need to need to create a virtual event that can be used everywhere in Mixpanel (e.g. inside a cohort definition or Funnel) + + +### Funnel Behaviors + + + Learn more about the [Funnels report](/docs/reports/funnels). + + +Funnel Behaviors define a sequence of events completed within a specified time frame. For example, save a behavior for the "Product Viewed through Purchased" Funnels. + +![](/saved-metrics-and-behaviors9.png) + +### Retention Behaviors + + + Learn more about the [Retention report](/docs/reports/retention). + + +Retention Behaviors look at when a user did an event, then came back to do the same or another event within a window of time. For example, we can save a behavior for our monthly returning purchasers. + +![](/saved-metrics-and-behaviors10.png) + +## Use Cases +You can use Saved Metrics and Saved Behaviors independently or combine them. Below are example use cases for each: + +**Metrics** + +- **Save time:** Avoid redundant work. If you frequently recreate the same metric across multiple reports or boards, saving it as a metric streamlines your workflow. + +- **Onboarding & ease of use:** Make it easy for anyone to understand what events and properties your organization uses to track your key metrics. + +- **Align your teams:** Establish trusted KPIs that all teams can rely on. This ensures everyone is working toward common goals using the same data. + +**Behaviors** + +- **Save time:** If you find yourself creating different metrics using the same set of events and filters, this is a good signal to create a saved behavior. + +- **Simplify updates:** Centralize definition management. If a specific user behavior or flow changes (e.g. your "Signup Flow" removes a step), you only need to update the saved behavior definition once. All saved metrics that rely on that behavior (e.g. "Signup Flow Time to Convert," "Signup Flow Conversion Rate," "Signup Flow Unique Users") will automatically reflect the updated Signup Flow definition. + +## Saving + +Click on the three dots menu next to the metric name. Select either **Save Metric** or **Saved Behavior**. You will be prompted to add a name and description. + +![](/saved-metrics-and-behaviors2.png) + +## Sharing + +By default, saved metrics and behaviors are private to you. After saving, you will be prompted to share. + +![](/saved-metrics-and-behaviors3.png) + +**Permissions** + +- Viewers: Can use this metric in analysis, but cannot modify the saved definition +- Editors: Can use this metric in analysis, and modify the saved definition + +**Audiences** +- Individuals: Set the permission for specific users in the project +- Project: Sets the permission for all users in the project + + + The best practice is to give the project **View** access and add any **Editors** individually. This ensures that everyone can use the definitions that are managed by select people. + + +## Using a Saved Metric or Behavior + +When you click “Select Metric” to populate your report, you will see all events as well as any saved definitions. You can search for a saved metric or behavior by name. Alternatively, you can browse the available saved metrics and behaviors using the tabs on the left. + +From an Insights report, you can select metrics and behaviors of all types. From Funnels and Retention reports, you will see only metrics and behaviors for that report type. + +![](/saved-metrics-and-behaviors4.png) + +## Updating Definitions +Saved metrics or behaviors definitions may change over time. Mixpanel enables you to easily update these definitions and apply the changes across all reports that use them. + +After selecting a saved metric or behavior, you can modify the definition in the Query Builder. You will see a dotted line around the metric or behavior icon if the definition has been modified from the last saved state. Click the three-dot menu to make updates. + +![](/saved-metrics-and-behaviors5.png) + +- **Push Changes:** This applies your new definition to the original saved metric/behavior. All reports using this metric/behavior will be updated with the new definition. +- **Save as New:** Creates a new metric with this new definition. The originally saved metric definition will not be affected. +- **Clear Changes:** Reverts back to the previously saved state. + +## Managing Saved Metrics and Behaviors + +You can view all Saved Metrics and Behaviors in your project, add descriptions to clearly define them, and delete any unwanted definitions directly from the [Lexicon](/docs/data-governance/lexicon). + +From the Lexicon, click the "Metrics" tab to access all [Saved Metrics](/docs/features/saved-metrics-and-behaviors#saved-metrics) and [Formulas](/docs/reports/insights#formulas). Click the Behaviors tab to access all [Saved Behaviors](/docs/features/saved-metrics-and-behaviors#saved-behaviors). + +![](/saved-metrics-and-behaviors6.png) + +Click on the name of the definition you want to modify or delete. From the detail page, you will see all the options to customize the metric, including: +- **Permissions:** Click "Share" to modify the metrics share settings. +- **Verify:** [Add Verified badges](/docs/data-governance/lexicon#verify-data) to the metric/behavior. Only project Admins and Owners can verify entities in the Lexicon. +- **Display Customizations:** Modify details about how this metric and its data appear by default. +- **Delete:** Remove a saved metric from the project. Note, any reports using that saved metric will retain the definition, but be displayed in an unsaved state. + +![](/saved-metrics-and-behaviors7.png) diff --git a/pages/docs/reports/funnels/funnels-advanced.mdx b/pages/docs/reports/funnels/funnels-advanced.mdx index f1413239b5..d90f33a85e 100644 --- a/pages/docs/reports/funnels/funnels-advanced.mdx +++ b/pages/docs/reports/funnels/funnels-advanced.mdx @@ -110,7 +110,7 @@ A step will either appear with a number beside it, indicating where it must fall If you have selected any order for your funnels steps, you have the option to select **Top paths** from the drop-down visualization list to view a [Sankey visualization](/docs/reports/flows#sankey-chart) of how your users are performing the steps in your funnel. -![/funnels_any.gif](/funnels_any.gif) +![/funnels_any.png](/funnels_any.png) ### Hold Property Constant @@ -151,29 +151,33 @@ A few things to note about exclusion steps: 3. There may be any number of exclusion events between steps. 4. Exclusion steps have the same [two second grace period](/docs/reports/funnels/funnels-faq#how-does-the-funnel-handle-simultaneous-events) as other steps in the funnel. -As an example, let's say you want to understand if users who browse for additional products between adding something to their cart and checking out are less likely to complete a purchase. To answer this question, you could create a funnel with three steps: +As an example, let's say you want to understand if users who add additional products to their cart and checking out are less likely to complete a purchase. To answer this question, you could create a funnel with four steps: -Step 1: Browse Product +Step 1: Product Viewed -Step 2: Add to Cart +Step 2: Product Added -Step 3: Purchase +Step 3: Checkout Started -You can exclude users who did another “Browse Product” event between Step 2 and Step 3 to see how that affects your funnel's conversion rate. +Step 4: Purchase Completed + +You can exclude users who did another “Product Added” event between Step 2 and Step 3 to see how that affects your funnel's conversion rate. To add an exclusion step in your funnel, expand the “Advanced” menu and click “Exclude users who did…”. Select an event from the list and choose whether you would like the event to be excluded between all steps, or between specific steps. Click the Filter icon beside the step to filter that event by an event or user profile property. -![/exclude_2.gif](/exclude_2.gif) +![/exclude_2.png](/exclude_2.png) ## Saved Funnel Behaviors -You can define a funnel behavior and save and share it. Press “Save as New” button to save your funnel behavior definition. You can change the name and add a description. +You can save the Funnel Behavior you built and reuse them in other reports. This can be helpful when there is a sequence of events that you frequently analyze (such as sign up flow), or if you want to analyze your Funnels Behavior along-side other metrics in an Insights report. + +Select the "..." button in the top right corner of the metric, then click "Save Behavior". Note that saving a behavior and saving a metric is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior. -You can also load existing funnel definitions by clicking the name of funnel. +![/saved-funnel-behavior1.png](/saved-funnel-behavior1.png) -See more about saved behaviors [here](/docs/features/saved-behaviors). +Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). ## Counting Methods and Measurements @@ -230,7 +234,7 @@ This measurement type allows you to visualize a numeric event property through a **Note**: For many e-commerce flows, you will want to pair property sum with [hold property constant](/docs/reports/funnels/funnels-advanced#hold-property-constant) on item ID so you can track each individual item. -To use property sum, select property sum from the measurement menu, and select a numeric property. In this case, we're seeing our 5 step purchase funnel, and we can see that our biggest drop-off is between viewing an item and adding it to cart. +To use property sum, select property sum from the measurement menu, and select a numeric property. ![funnels_property_sum.png](/funnels_property_sum.png) diff --git a/pages/docs/reports/funnels/funnels-quickstart.mdx b/pages/docs/reports/funnels/funnels-quickstart.mdx index 8775797d11..59b4948b10 100644 --- a/pages/docs/reports/funnels/funnels-quickstart.mdx +++ b/pages/docs/reports/funnels/funnels-quickstart.mdx @@ -12,15 +12,19 @@ A funnel is a sequence of events done within a defined period of time. A convert ## Step 1: Define your Funnel Behavior -A funnel is the basic building block of the Funnels report. A funnel is a sequence of events done within a defined period of time. +A Funnel Behavior is the basic building block of the Funnels report. A Funnel Behavior is a sequence of events done within a defined period of time. -For example, let's say your signup flow contains five steps. Within the funnel definition, you can add one event for each step, in the following order: “Landing Page” → “Download Page” → “App Install” → “App Open” → “Sign Up.” At this point, your query should look like this. +For example, let's say your signup flow contains five steps. Within the funnel definition, you can add one event for each step, in the following order: “Product Viewed” → “Product Added” → “Checkout Started” → “Purchase Completed”. At this point, your query should look like this. ![/funnels_beta_1.png](/funnels_beta_1.png) +You can save the Funnel Behavior you built and reuse them in other reports. Select the "..." button in the top right corner of the metric, then click "Save Behavior". Note that saving a behavior and saving a metric is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior. + +Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). + ## Step 2: Choose your Measurement -After your funnel is defined, you can choose how you want to measure the funnel. By default, the Funnels report will select the unique conversion rate of the funnel as the measurement. +After your Funnel Behavior is defined, you can choose how you want to measure the Funnel. By default, the Funnels report will select the unique conversion rate of the funnel as the measurement. **Advanced** - See [Counting Method and Measurements](/docs/reports/funnels/funnels-advanced#counting-methods-and-measurements) section for more information on the measurements. @@ -28,6 +32,10 @@ After your funnel is defined, you can choose how you want to measure the funnel. ![/funnels_beta_2.png](/funnels_beta_2.png) +Your Funnel Behavior combined with the measurement forms a Metric. You can save the Funnels Metric you built and reuse them in other reports (such as the Insights report). Select the "..." button in the top right corner of the metric, then click "Save Behavior". Note that saving a behavior and saving a metric is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior. + +Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). + ## Step 3: Choose Filters In this case, we only care about events performed on the iOS platform. Therefore, add a “Platform” filter, where Platform equals “iOS Native”. At this point, your query should look like this. diff --git a/pages/docs/reports/insights.mdx b/pages/docs/reports/insights.mdx index b2f87f4741..a38a428a8f 100644 --- a/pages/docs/reports/insights.mdx +++ b/pages/docs/reports/insights.mdx @@ -38,35 +38,39 @@ It's important to know what's the natural frequency at which your users use your

-### Step 1: Choose or Define your Behavior +### Step 1: Define your Behavior -Metrics are basing building blocks of an Insights report. A metric is made up of a behavior, and a way to measure that behavior. By default, Insights will prompt you to select the most basic form of a behavior: an event. However, you can also press the "+ Metrics" button to select add a metric based on a different type of behavior. You can also add a formula, which is a metric that is a function of other metrics. +Metrics are the basic building blocks of an Insights report, and consists of profiles (users, groups, Cohorts) or behaviors (events, Funnels behavior, or Retention behavior) along with a measurement of those entities. Press the "Select Metrics" button to add a metric. -To select an event and start with an event based metric, press "Select Event". +To select an event and start with an event-based simple behavior metric, choose "Events" in the left column of the metrics menu, then select the events you want to measure. This creates a simple behavior. ![Choose Events](/choose-events.png) -To select a different type of metric, press "+ Metrics" and choose your metric type from the list. See [Metric Types](/docs/reports/insights#metric-types) for a full list of supported metric types. - -![Choose Metrics](/choose-metrics.png) +You can save the behavior you built and reuse them in other reports. Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). ### Step 2: Choose your Measurement -Once you've selected your behavior, you can choose how to measure that behavior. Depending on the type of behavior selected, Insights will default to a different measurement. If you're measuring a basic event, Insights will default to measuring the number of unique users who have done that event. +Once you've selected your behavior, you can choose how to measure that behavior. A behavior combined with a measurement forms a Metric. + +Depending on the type of behavior selected, Insights will default to a different measurement. If you're measuring a Simple Behavior (events), Insights will default to measuring the number of unique users who have done that event. ![Choose Measurement](/choose-measurement.png) +You can save the metric you built and reuse them in other reports. Select the "..." button in the top right corner of the metric, then click "Save Metric". Note that saving a metric and saving a behavior is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior. + +Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). + ### Step 3: Choose Filters -Filters exclude unwanted data. In this case, we only care about events performed on the iOS platform. Therefore, add a "Platform" filter, where Platform equals "iOS Native". At this point, your query should look like this: +Filters exclude unwanted data. In this case, we only care about events performed on the iOS platform. Therefore, add a "Operating System" filter, where OS equals "iOS". At this point, your query should look like this: -![Choose Filters](/choose-filters.gif) +![Choose Filters](/choose-filters.png) ### Step 4: Choose Breakdowns -Breakdowns segment data into groups. In this case, we want to count message-sending users in different cities. Therefore, add a "City" breakdown. At this point, your query should look like this: +Breakdowns segment data into groups. In this case, we want to count sign ups based on users in different cities. Therefore, add a "City" breakdown. At this point, your query should look like this: -![Choose Breakdowns](/choose-breakdowns.gif) +![Choose Breakdowns](/choose-breakdowns.png) ### Step 5: Change Visualization @@ -80,20 +84,34 @@ You now have a full analysis that you can use and add onto a Board, or use as a ## Basic Features -### Metric Types +### Metrics + +Metrics are the basic building blocks of an Insights report, and consists of profiles (users, groups, Cohorts) or behaviors (events, Funnels behavior, or Retention behavior) along with a measurement of those entities. The table below outlines the types of Metrics that can be analyzed in the Insights report. + +**Behavioral Metrics** + +| Metric Type | Description | +| --- | --- | +| Simple Behavior (events) | A metric based off of an event or group of events. The metric could measure the total number of occurrences, unique users, or aggregates a property of this event. | +| Funnel Behavior | A metric based off a funnel behavior. You can select a saved funnel behavior or define a new funnel, then choose a measurement on that funnel to form a funnel metric. By default measures conversion rate on all steps of the funnel. | +| Retention Behavior | A metric based off a retention behavior. You can select a saved retention behavior or define a new retention, then choose a measurement to form a retention metric. By default, measures retention rate. | + +**Other Metrics** | Metric Type | Description | | --- | --- | -| Event | A metric based off of a single event. The metric could measure the total number of occurrences, unique users, or aggregates a property of this event. | | Profile | A metric based off of the user or group profiles. You can measure the number of profiles, or an aggregate on properties of the profiles. | -| Formula | A metric that is a function of other metrics. You can select a saved formula, or create a new formula based on the existing metrics in the report. | -| Funnel | A metric based off a funnel behavior. You can select a saved funnel behavior or define a new funnel, then choose a measurement on that funnel to form a funnel metric. By default measures conversion rate on all steps of the funnel. | -| Retention | A metric based off a retention behavior. You can select a saved retention behavior or define a new retention, then choose a measurement to form a retention metric. By default, measures retention rate. | | Cohort | A metric based off of a defined cohort. Measures the number of users who are part of that cohort. | +| Formula | A metric that is a function of other metrics. You can select a saved formula, or create a new formula based on the existing metrics in the report. | + +#### Saving Metrics and Behaviors +You can save the metric and behaviors you built and reuse them in other analysis. Select the "..." button in the top right corner of the metric, then click "Save Metric" or "Save Behavior". Note that saving a metric and saving a behavior is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the behavior together with the measurements of the behavior. + +Learn more about [Saved Metrics and Behavior](/docs/features/saved-metrics-and-behaviors). -If choosing Formula, Funnel, Retention or Cohort, you will be prompted first to selected a saved definition. If you wish to start by defining your own behavior, press "Create" in the top right of the menu. +![Insights Saved Behaviors](/insights-saved-behavior.png) -### Chart Types +### Charts Insights feature multiple visualizations to help you view the query results in the clearest chart type. By default, Insights displays the results on the line chart, which helps you understand how metrics trend over time. However, another chart type might present the results with more clarity. In Insights, you can choose to get a metric calculated either across the entire time period selected in the date picker or on a time-segmented view of the metric (e.g. daily breakdown). @@ -165,20 +183,23 @@ The Grouped View preserves the hierarchy of breakdowns. It shows you segments wi You can sort segments alphabetically or by the value of a particular metric. In the grouped view, sorting is configured on a per-breakdown level and respects the breakdown hierarchy. In the below image, we sort Country *within* Item Category, which respects the hierarchy. + ![image](https://github.com/mixpanel/docs/assets/2077899/4697ce00-d394-46ce-b538-66ec91ccd6e7) -Hierarchy is defined by the breakdown order in the query panel: -![image](https://github.com/mixpanel/docs/assets/2077899/ff2f72b3-89bc-459e-b8b7-e81655d04bb7) +Hierarchy is defined by the breakdown order in the query panel. ###### View “N” segments The View “N” control lets you decide how many rows to display per breakdown in your table. + ![View_N_gif](https://github.com/mixpanel/docs/assets/2077899/4fb0fd18-2ef7-416b-adaa-c7299da0f7b3) In the ungrouped view, choose the number of rows to display: + ![image](https://github.com/mixpanel/docs/assets/2077899/b1b25b19-51be-4934-bbfd-7562e0f98d4a) In the grouped view, you can choose the number of rows you want to display for each breakdown: + ![image](https://github.com/mixpanel/docs/assets/2077899/f9f8c83c-34ed-44bd-b4e7-f60b70255a6f) ![image](https://github.com/mixpanel/docs/assets/2077899/b09c1ad1-1392-4ec0-9358-361f677c600d) @@ -191,6 +212,7 @@ In the grouped view, you can choose the number of rows you want to display for e ##### Overall and Segment Sub-Totals **Overall:** This refers to the value considering all the segments, independent of whether displayed or not based on your View N control; i.e changes to View N will not affect Overall numbers + ![image](https://github.com/mixpanel/docs/assets/2077899/3d6556a4-9468-4d1f-8979-4fdb512f2aaa) **Sub-Totals:** In the grouped view, in addition to the Overall, segment sub-totals are also displayed. Similar to “Overall”, these values are independent of the View N control @@ -228,7 +250,7 @@ To note, you cannot nest a formula metric when constructing another formula. Use existing events to create calculated formulas, like Bounce Rate & % Active Users, that can be saved and reused by others within the project. -![saveformula.gif](/saveformula.gif) +![saveformula.gif](/saveformula.png) Some nuances to note: - Once you save a formula, A,B,C refer to what’s **within** the saved formula modal @@ -240,8 +262,6 @@ To access and re-use saved formulas, click on “+Formula”, and then see the l - All roles can create a saved formula, but only some roles can share them with the whole project for re-use - You can only look at saved formulas created by you or shared with you -![reuseformula.gif](/reuseformula.gif) - ### Custom Bucketing Insights will automatically group your high-cardinality segments into buckets. Buckets can be edited by using the "Custom Buckets" option in the overflow menu: @@ -373,10 +393,7 @@ There are some cases though, where you want to know how the 2441 users are distr ![image](/uniques_count_once.png) -To note - in a line chart, there are two concepts of time period: chart date range (3M below) and time interval (weekly interval below). When advanced controls are used in a line chart, it assigns a segment based on the first/last segment for each time interval, NOT across all time intervals in the chart range. For eg. user Joey could count towards Contact Page Wk of Feb 27 and Shop Page Wk of March 6. But in the same time interval, they would count only towards one segment. - -![image](/uniques_count_once_line.png) - +To note - in a line chart, there are two concepts of time period: chart date range (3M below) and time interval (weekly interval below). When advanced controls are used in a line chart, it assigns a segment based on the first/last segment for each time interval, NOT across all time intervals in the chart range. #### Aggregate Property | Function Name | Events Calculation | Profiles Calculation | diff --git a/pages/docs/reports/retention.mdx b/pages/docs/reports/retention.mdx index 065f6f334f..4c12a817d3 100644 --- a/pages/docs/reports/retention.mdx +++ b/pages/docs/reports/retention.mdx @@ -26,10 +26,14 @@ Building a Retention report follows the same high level steps as building any ot ### Step 1: Define your Retention Behavior -The retention behavior is the basic building block of a Retention report. A retention behavior is doing an event and then coming back to do another event. In this case, since we want to know retention after signup, choose "Sign Up Completed" in the first event slot. Then, we want to know if users are coming back and using the product, so choose "Any Event" in the second event slot. At this point, your query should look like this: +The Retention Behavior is the basic building block of a Retention report. A Retention Behavior is doing an event and then coming back to do another event. In this case, since we want to know retention after signup, choose "Sign Up Completed" in the first event slot. Then, we want to know if users are coming back and using the product, so choose "Any Event" in the second event slot. At this point, your query should look like this: ![/retention_beta_1.png](/retention_beta_1.png) +You can save the Retention Behavior you built and reuse them in other reports. Select the "..." button in the top right corner of the metric, then click "Save Behavior". Note that saving a behavior and saving a metric is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior. + +Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). + ### Step 2: Choose your Measurement After your retention behavior is defined, you can choose how you want to measure it. By default, Retention report will select retention rate as the measurement. @@ -42,6 +46,10 @@ There are 4 types of measurement ![/Updated_retention_measurements.png](/Updated_retention_measurements.png) +Your Retention Behavior combined with the measurement forms a Metric. You can save the Retention Metric you built and reuse them in other reports (such as the Insights report). Select the "..." button in the top right corner of the metric, then click "Save Behavior". Note that saving a behavior and saving a metric is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior. + +Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). + ### Step 3: Choose Filters Filters exclude unwanted data. In this case, we only care about events performed on Chrome browser. Therefore, add a "Browser" filter, where Browser equals "Chrome". At this point, your query should look like this: @@ -236,15 +244,13 @@ Above said, general expectation is product use-cases which focus on user stickin ### Saved Retention Behaviors -You can define a retention behavior and save and share it. Press "Save as New" button to save your retention behavior definition. You can change the name and add a description. - -![save retention](/save-retention-1.png) +You can save the Funnel Behavior you built and reuse them in other reports. This can be helpful when there is a sequence of events that you frequently analyze (such as sign up flow), or if you want to analyze your Funnels Behavior along-side other metrics in an Insights report. -You can also load existing retention behavior definitions by clicking the name of retention behavior. +Select the "..." button in the top right corner of the metric, then click "Save Behavior". Note that saving a behavior and saving a metric is different; a saved behavior consists of the events/Funnels/Retention, while a saved metrics consists of the saved behavior and the measurements of the behavior. -![save retention](/save-retention-2.png) +[INSERT IMAGE] -See more about saved behaviors [here](/docs/features/saved-behaviors). +Learn more about [Saved Metrics and Behaviors](/docs/features/saved-metrics-and-behaviors). ### Frequency View diff --git a/public/13599603833876.png b/public/13599603833876.png index 9d85c586e2..39f697ccac 100644 Binary files a/public/13599603833876.png and b/public/13599603833876.png differ diff --git a/public/13599765981076.png b/public/13599765981076.png index a6c5070995..22d6ba1c9a 100644 Binary files a/public/13599765981076.png and b/public/13599765981076.png differ diff --git a/public/Retention_3_3.png b/public/Retention_3_3.png index 55d561372e..7866af3c7f 100644 Binary files a/public/Retention_3_3.png and b/public/Retention_3_3.png differ diff --git a/public/Retention_7_30.png b/public/Retention_7_30.png index f43dc33bdf..49c39903e2 100644 Binary files a/public/Retention_7_30.png and b/public/Retention_7_30.png differ diff --git a/public/Retention_Breakdown.png b/public/Retention_Breakdown.png index 6e7727ee47..e01cfe8bde 100644 Binary files a/public/Retention_Breakdown.png and b/public/Retention_Breakdown.png differ diff --git a/public/Retention_Filter.png b/public/Retention_Filter.png index f74b61c6d6..5d36d28301 100644 Binary files a/public/Retention_Filter.png and b/public/Retention_Filter.png differ diff --git a/public/Retention_Setting_Custom.png b/public/Retention_Setting_Custom.png index d34eb05bd0..79cd4d7f62 100644 Binary files a/public/Retention_Setting_Custom.png and b/public/Retention_Setting_Custom.png differ diff --git a/public/Retention_Trend.png b/public/Retention_Trend.png index 2e32cff4e3..78c7520248 100644 Binary files a/public/Retention_Trend.png and b/public/Retention_Trend.png differ diff --git a/public/Screen_Shot_2022-07-05_at_4.41.04_PM.png b/public/Screen_Shot_2022-07-05_at_4.41.04_PM.png index a3589a4c96..c5274ad5fa 100644 Binary files a/public/Screen_Shot_2022-07-05_at_4.41.04_PM.png and b/public/Screen_Shot_2022-07-05_at_4.41.04_PM.png differ diff --git a/public/Screen_Shot_2022-07-05_at_4.49.46_PM.png b/public/Screen_Shot_2022-07-05_at_4.49.46_PM.png index 6ae9bf14d0..db1ce0d6c0 100644 Binary files a/public/Screen_Shot_2022-07-05_at_4.49.46_PM.png and b/public/Screen_Shot_2022-07-05_at_4.49.46_PM.png differ diff --git a/public/Updated_retention_criteria.png b/public/Updated_retention_criteria.png index 6a88c60711..28388416a3 100644 Binary files a/public/Updated_retention_criteria.png and b/public/Updated_retention_criteria.png differ diff --git a/public/Updated_retention_measurements.png b/public/Updated_retention_measurements.png index 160d0387f1..eb978a2d03 100644 Binary files a/public/Updated_retention_measurements.png and b/public/Updated_retention_measurements.png differ diff --git a/public/advanced-data-functions-1.png b/public/advanced-data-functions-1.png index 6ee110eb0f..0b48b3a901 100644 Binary files a/public/advanced-data-functions-1.png and b/public/advanced-data-functions-1.png differ diff --git a/public/advanced-data-functions-2.png b/public/advanced-data-functions-2.png index 67d2f1396a..0bf8bc2832 100644 Binary files a/public/advanced-data-functions-2.png and b/public/advanced-data-functions-2.png differ diff --git a/public/advanced-data-functions-3.png b/public/advanced-data-functions-3.png index 9a1d190c9d..6ffe3ad8cd 100644 Binary files a/public/advanced-data-functions-3.png and b/public/advanced-data-functions-3.png differ diff --git a/public/advanced-formulas-1.png b/public/advanced-formulas-1.png index 799719f73c..b68fd669d4 100644 Binary files a/public/advanced-formulas-1.png and b/public/advanced-formulas-1.png differ diff --git a/public/change-visualization.png b/public/change-visualization.png index a1d2923107..ac1c044999 100644 Binary files a/public/change-visualization.png and b/public/change-visualization.png differ diff --git a/public/choose-breakdowns.png b/public/choose-breakdowns.png new file mode 100644 index 0000000000..54772e70da Binary files /dev/null and b/public/choose-breakdowns.png differ diff --git a/public/choose-events.png b/public/choose-events.png index 7ebebd72b0..02119ac53c 100644 Binary files a/public/choose-events.png and b/public/choose-events.png differ diff --git a/public/choose-filters.png b/public/choose-filters.png new file mode 100644 index 0000000000..21e912698f Binary files /dev/null and b/public/choose-filters.png differ diff --git a/public/choose-measurement.png b/public/choose-measurement.png index fa531deaec..4d0d216777 100644 Binary files a/public/choose-measurement.png and b/public/choose-measurement.png differ diff --git a/public/custom_event_qb.png b/public/custom_event_qb.png new file mode 100644 index 0000000000..3577ecccf5 Binary files /dev/null and b/public/custom_event_qb.png differ diff --git a/public/exclude_2.png b/public/exclude_2.png new file mode 100644 index 0000000000..1f9c77a7c2 Binary files /dev/null and b/public/exclude_2.png differ diff --git a/public/funnels_any.png b/public/funnels_any.png new file mode 100644 index 0000000000..2afab9d6f4 Binary files /dev/null and b/public/funnels_any.png differ diff --git a/public/funnels_attribution1.png b/public/funnels_attribution1.png index fbe71a95bb..1b8e5b52d5 100644 Binary files a/public/funnels_attribution1.png and b/public/funnels_attribution1.png differ diff --git a/public/funnels_beta_1.png b/public/funnels_beta_1.png index c1173e3bea..395c3d0771 100644 Binary files a/public/funnels_beta_1.png and b/public/funnels_beta_1.png differ diff --git a/public/funnels_beta_2.png b/public/funnels_beta_2.png index 7705e9907a..7fd437b6c6 100644 Binary files a/public/funnels_beta_2.png and b/public/funnels_beta_2.png differ diff --git a/public/funnels_beta_3.png b/public/funnels_beta_3.png index 55d47301ca..0ea0d504ed 100644 Binary files a/public/funnels_beta_3.png and b/public/funnels_beta_3.png differ diff --git a/public/funnels_beta_4.png b/public/funnels_beta_4.png index 72e417d11d..8d1ba01bb9 100644 Binary files a/public/funnels_beta_4.png and b/public/funnels_beta_4.png differ diff --git a/public/funnels_comparison.png b/public/funnels_comparison.png index c3ea124120..202fe4ec74 100644 Binary files a/public/funnels_comparison.png and b/public/funnels_comparison.png differ diff --git a/public/funnels_filter1.png b/public/funnels_filter1.png index 65ca746624..57d4a15ab0 100644 Binary files a/public/funnels_filter1.png and b/public/funnels_filter1.png differ diff --git a/public/funnels_property_sum.png b/public/funnels_property_sum.png index 070fee6b32..0997760135 100644 Binary files a/public/funnels_property_sum.png and b/public/funnels_property_sum.png differ diff --git a/public/insights-saved-behavior.png b/public/insights-saved-behavior.png new file mode 100644 index 0000000000..730c11fa60 Binary files /dev/null and b/public/insights-saved-behavior.png differ diff --git a/public/retention_beta_1.png b/public/retention_beta_1.png index 637dfe9783..b1dbb46171 100644 Binary files a/public/retention_beta_1.png and b/public/retention_beta_1.png differ diff --git a/public/retention_beta_5.png b/public/retention_beta_5.png index 15fed1697e..811104c952 100644 Binary files a/public/retention_beta_5.png and b/public/retention_beta_5.png differ diff --git a/public/rolling-cumulative.png b/public/rolling-cumulative.png index 53e57aee0c..ffdd5b8fbc 100644 Binary files a/public/rolling-cumulative.png and b/public/rolling-cumulative.png differ diff --git a/public/saved-funnel-behavior1.png b/public/saved-funnel-behavior1.png new file mode 100644 index 0000000000..fcd3563d73 Binary files /dev/null and b/public/saved-funnel-behavior1.png differ diff --git a/public/saved-metrics-and-behaviors1.png b/public/saved-metrics-and-behaviors1.png new file mode 100644 index 0000000000..8a4e9b570e Binary files /dev/null and b/public/saved-metrics-and-behaviors1.png differ diff --git a/public/saved-metrics-and-behaviors10.png b/public/saved-metrics-and-behaviors10.png new file mode 100644 index 0000000000..a9633db3fe Binary files /dev/null and b/public/saved-metrics-and-behaviors10.png differ diff --git a/public/saved-metrics-and-behaviors11.png b/public/saved-metrics-and-behaviors11.png new file mode 100644 index 0000000000..2a63bbe889 Binary files /dev/null and b/public/saved-metrics-and-behaviors11.png differ diff --git a/public/saved-metrics-and-behaviors12.png b/public/saved-metrics-and-behaviors12.png new file mode 100644 index 0000000000..1a25d36978 Binary files /dev/null and b/public/saved-metrics-and-behaviors12.png differ diff --git a/public/saved-metrics-and-behaviors2.png b/public/saved-metrics-and-behaviors2.png new file mode 100644 index 0000000000..59e6199428 Binary files /dev/null and b/public/saved-metrics-and-behaviors2.png differ diff --git a/public/saved-metrics-and-behaviors3.png b/public/saved-metrics-and-behaviors3.png new file mode 100644 index 0000000000..a20d5fd9d3 Binary files /dev/null and b/public/saved-metrics-and-behaviors3.png differ diff --git a/public/saved-metrics-and-behaviors4.png b/public/saved-metrics-and-behaviors4.png new file mode 100644 index 0000000000..cb983e4bdf Binary files /dev/null and b/public/saved-metrics-and-behaviors4.png differ diff --git a/public/saved-metrics-and-behaviors5.png b/public/saved-metrics-and-behaviors5.png new file mode 100644 index 0000000000..67205315e9 Binary files /dev/null and b/public/saved-metrics-and-behaviors5.png differ diff --git a/public/saved-metrics-and-behaviors6.png b/public/saved-metrics-and-behaviors6.png new file mode 100644 index 0000000000..4dde9dc496 Binary files /dev/null and b/public/saved-metrics-and-behaviors6.png differ diff --git a/public/saved-metrics-and-behaviors7.png b/public/saved-metrics-and-behaviors7.png new file mode 100644 index 0000000000..7427171d18 Binary files /dev/null and b/public/saved-metrics-and-behaviors7.png differ diff --git a/public/saved-metrics-and-behaviors8.png b/public/saved-metrics-and-behaviors8.png new file mode 100644 index 0000000000..7d1892473a Binary files /dev/null and b/public/saved-metrics-and-behaviors8.png differ diff --git a/public/saved-metrics-and-behaviors9.png b/public/saved-metrics-and-behaviors9.png new file mode 100644 index 0000000000..4593d14090 Binary files /dev/null and b/public/saved-metrics-and-behaviors9.png differ diff --git a/public/saved_behavior_group_identifier.png b/public/saved_behavior_group_identifier.png new file mode 100644 index 0000000000..8a0705b209 Binary files /dev/null and b/public/saved_behavior_group_identifier.png differ diff --git a/public/saveformula.png b/public/saveformula.png new file mode 100644 index 0000000000..7db144088e Binary files /dev/null and b/public/saveformula.png differ diff --git a/public/step-selection.png b/public/step-selection.png index 9acd5c2436..00c57bdacc 100644 Binary files a/public/step-selection.png and b/public/step-selection.png differ diff --git a/public/toc_measurement.png b/public/toc_measurement.png index 6c8d9b4236..e0d4949b16 100644 Binary files a/public/toc_measurement.png and b/public/toc_measurement.png differ diff --git a/public/uniques_count_once.png b/public/uniques_count_once.png index cb6f4c975e..5834236731 100644 Binary files a/public/uniques_count_once.png and b/public/uniques_count_once.png differ diff --git a/public/uniques_default.png b/public/uniques_default.png index 87859c08de..352e021e03 100644 Binary files a/public/uniques_default.png and b/public/uniques_default.png differ