Skip to content

Commit

Permalink
pricing callouts (#1732)
Browse files Browse the repository at this point in the history
* saved reports callout

* saved cohorts callout

* saved modeled entity callout

* experiment, impact, and signal callout

* JQL callout

* report-level permissions callout

* escape character for JQL table

* revert JQL back to MD

* alert and anomaly detection callout

* Formatted API callout

* data view and classification callout

* org roles callout

* SSO callout

* add attribution mp4

* multi-touch attribution callout

* saved formulas callout

* saved behavior metric callout

* group analytics callout

* data pipeline callouts A

* data pipeline callout B

* data pipeline callout C

* warehouse connector callout

* event approval callout

* data volume monitoring callout

* verify data callout

* lookup table callout

---------

Co-authored-by: Myron Fung <[email protected]>
  • Loading branch information
myronkaifung and Myron Fung authored Jan 25, 2025
1 parent 69762d3 commit d765d86
Show file tree
Hide file tree
Showing 42 changed files with 271 additions and 67 deletions.
6 changes: 5 additions & 1 deletion pages/docs/access-security/single-sign-on.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@ import { Callout } from 'nextra/components'

# Single Sign-On: Use SSO to access Mixpanel

<Callout type="info">
Users on an Enterprise plan can enable Single Sign-On for authentication. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

## Overview

You can use Single Sign-On (SSO) to access Mixpanel. You must be on a **Mixpanel Enterprise plan** and use an identity provider or a custom SAML implementation in order to use SSO with Mixpanel.
Single sign-on (SSO) allows users to log into multiple platforms, services, or systems using a single ID and password combination. Mixpanel supports SSO and works with any SAML 2.0-compliant SSO provider.

## Access SSO Settings

Expand Down
12 changes: 7 additions & 5 deletions pages/docs/boards/advanced.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components'

# Advanced

## Board-wide Date Ranges and Filters
Expand Down Expand Up @@ -66,7 +68,11 @@ It is possible to subscribe to a private board. However, there are some restrict
1. If you convert a regular board with subscriptions into a private board, existing subscriptions will still work with existing recipients. However, if they click **View Board**, they will not be able to access your private board. Creating new subscriptions or editing existing subscriptions within the private board will force you to limit recipients to yourself.
2. You cannot edit subscriptions of someone else’s private board without selecting a different board that you have access to (regardless of your permissions or role). You can still delete the subscription or select a different board.

## Sharing
## Sharing and Permissions

<Callout type="info">
Growth and Enterprise plan users can control who views and edits reports in a board. Free plan users have view and edit permissions for all boards and reports in a project. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Sharing and permissions are set at the board level, and all reports saved on a board inherit the same set of sharing and permissions settings of that board.

Expand All @@ -80,10 +86,6 @@ Both reports and boards can also be shared via the "Copy URL" button at the top

So long as the recipient has access to the project, they will be able to see the shared report or board. However, unless they have specifically given Editor permissions, they will only be able to view it, not edit it.

## Permissions

Sharing and permissions are set at the board level, and all reports saved on a board inherit the same set of sharing and permissions settings of that board.

In the sharing process, you can choose the permissions level granted to the individual with whom you're sharing the board. Teammates with access to a board can either be Viewers (any changes made will not be saved) or Editors (changes made will be saved). 

As with sharing, setting a user's permission level on a board will give them the same permission level for all reports on that board.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
import { Callout } from 'nextra/components'

# Data Views & Classification: Filter team access to your data within a project

<Callout type="info">
Users on an Enterprise plan can access the Data View and Data Classification features. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

## Data Views Overview

Data Views allow you to manage data access for a group of users within a single Mixpanel project. [Project Owners and Admins](/docs/orgs-and-projects/roles-and-permissions#permissions) can create and edit Data Views and determine access for privacy and productivity purposes. You must have an active **Enterprise** plan with Mixpanel to access this feature.
Data Views allow you to manage data access for a group of users within a single Mixpanel project. [Project Owners and Admins](/docs/orgs-and-projects/roles-and-permissions#permissions) can create and edit Data Views and determine access for privacy and productivity purposes.

### Use Cases

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { Callout } from 'nextra/components'

# Data Volume Monitoring: Get notified about drastic changes in event volume

<Callout type="info">
Customers on an Enterprise can access the Data Volume Monitoring feature. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

## Overview

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
import { Callout } from 'nextra/components'

# Event Approval: Review unexpected events before they are visible

<Callout type="info">
Customers on an Enterprise can access the Event Approval feature. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

## Overview

Event Approval is a Data Governance feature for organizations that want visibility and control over all new events being sent to their Mixpanel project. The feature is a project-level setting for Enterprise accounts that hides new events by default and notifies admins when those new events come in so they can then mark it as visible for everyone to see.
Event Approval is a Data Governance feature for organizations that want visibility and control over all new events being sent to their Mixpanel project. The feature is a project-level setting that hides new events by default and notifies admins when those new events come in so they can then mark it as visible for everyone to see.


### Enabling Event Approval
Expand Down
9 changes: 6 additions & 3 deletions pages/docs/data-governance/lexicon.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Lexicon: Describe your events and data using a dictionary
import { Callout } from 'nextra/components'

# Lexicon: Describe your events and data using a dictionary

## Overview

Expand Down Expand Up @@ -244,12 +245,14 @@ To unmerge properties:

## Verify Data

<Callout type="info">
Customers on an Enterprise can access the Verified Data feature. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Verified Data in Mixpanel allows designated project owners and admins to add Verified badges to certain Events, Behaviors, Formulas, and Custom Events. This signals to other users within your project that this data has been vetted and can be confidently used for analysis and reporting.

By providing a clear distinction between vetted and non-vetted data, it becomes easier for teams to adopt Mixpanel, knowing they are using the right events.

This feature is only available for customers on Enterprise plans.

**How it Works**

1. Navigate to Lexicon
Expand Down
6 changes: 5 additions & 1 deletion pages/docs/data-pipelines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ import { Callout } from 'nextra/components'
go to docs [here](/docs/data-pipelines/old-pipelines).
</Callout>

Data Pipelines is a [paid add-on](https://mixpanel.com/pricing) that continuously exports data from your Mixpanel project to a Cloud Storage bucket or Data Warehouse of your choice. This feature is ideal for those who wish to perform SQL analysis on Mixpanel data within their own environment.
<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Data Pipelines is a feature that continuously exports data from your Mixpanel project to a Cloud Storage bucket or Data Warehouse of your choice. This feature is ideal for those who wish to perform SQL analysis on Mixpanel data within their own environment.

Setting up Data Pipelines involves two main steps:

Expand Down
10 changes: 7 additions & 3 deletions pages/docs/data-pipelines/integrations.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
import { Cards } from 'nextra/components'
import { Cards, Callout } from 'nextra/components'

# Integrations: Export your Mixpanel data to a third-party tool
# Integrations: Export your Mixpanel data to a data warehouse

These integrations allow you to send your Mixpanel data into a third-party tool.
<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

These integrations allow you to send your Mixpanel data into a data warehouse.

## Featured Integrations
<Cards>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# AWS S3

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Mixpanel allows you to export events and people data into AWS S3 through [Json Pipelines](/docs/data-pipelines)

## Setting S3 Permissions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Azure Blob Storage

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Mixpanel allows you to export events and people data directly into an Azure Blob Storage instance through [Json Pipelines](/docs/data-pipelines).

## Setting Blob Storage Permissions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# BigQuery

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

This guide describes how Mixpanel exports your data into a customer-managed [Google BigQuery](https://cloud.google.com/bigquery/) dataset.

## Design
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# AWS Redshift Spectrum

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Mixpanel's JSON pipelines enable direct export of your Mixpanel data into an S3 bucket, facilitating the use of Redshift Spectrum for querying.

## Design
Expand Down Expand Up @@ -246,7 +252,7 @@ Follow these steps to grant the `CREATE` privilege:
--database <your-database-name> \
--sql "SELECT 1;"
```
- Grant `CREATE` privilege. Click **Query data** in the Amazon Redshift console to open **Query Editor v2**. Connect using appropriate credentials and run the following SQL commands, replacing <your-database-name> and <mixpanel-role-name> with your actual values:
- Grant `CREATE` privilege. Click **Query data** in the Amazon Redshift console to open **Query Editor v2**. Connect using appropriate credentials and run the following SQL commands, replacing `<your-database-name>` and `<mixpanel-role-name>` with your actual values:

```sql
-- Check if the IAMR user has been created
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Snowflake

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

This guide describes how Mixpanel data is exported into a Snowflake dataset. Create a pipeline to export your Mixpanel data into Snowflake. Once an export job is scheduled, Mixpanel exports data to Snowflake on a recurring basis.

## Design
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Json Pipelines

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Json Pipeline is designed to export your Mixpanel data to supported data warehouses or object storage solutions. We maintain all properties in a high-level JSON format under the `properties` key for both events and user profile data.

This documentation is intended for users with intermediate or advanced knowledge of databases and familiarity with Amazon Web Services, Google Cloud Platform, or Snowflake technology.
Expand Down
15 changes: 4 additions & 11 deletions pages/docs/data-pipelines/old-pipelines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,17 @@ import { Callout } from 'nextra/components'

## Overview

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

<Callout type="warning">
This version of managing pipelines via API is Deprecated going forward.
For the customers who earlier used these apis to create and manage can continue using it.
Otherwise Go to Integrations page in mixpanel to create and manage pipelines via UI and
go to [docs](/docs/data-pipelines) for more info.
</Callout>

<Callout type="warning">
If your Mixpanel org was created before Sep 2024 and you just start setting up Data Pipelines,
by default you will use the older version of pipelines.
If you want to use Json Pipelines, please reach out to our support team for assistance.
</Callout>

<Callout type="info">
Data Pipelines is a paid add-on. Visit our [pricing
page](https://mixpanel.com/pricing) to add it to your plan.
</Callout>

Data Pipelines continuously exports the events in your Mixpanel project to a cloud storage bucket or data warehouse of your choice. It's useful if you want to analyze Mixpanel events using SQL in your own environment.

Using Data Pipelines requires 2 steps:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Raw AWS Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

To set up a raw export pipeline to an S3 bucket from Mixpanel, you must configure S3 to receive the exported data, then [create a pipeline](https://developer.mixpanel.com/reference/create-warehouse-pipeline) to export the data.

The following document summarizes the steps to edit S3 bucket permissions so that it accepts the Mixpanel export. Consult [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/gsg/GetStartedWithS3.html) for any AWS specific tasks, such as creating an [S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html) and editing [permissions](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Raw Azure Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

To set up a raw export pipeline to Azure Blob Storage from Mixpanel, you must first give Mixpanel permission to write to Azure. Next you can [create a pipeline](https://developer.mixpanel.com/reference/create-warehouse-pipeline) to export the data. Mixpanel then uploads the data to Azure Blob Storage on a recurring basis.

The following document summarizes the steps to configure Azure permissions so that it accepts the Mixpanel export, and provides an example request to create the pipeline.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Raw GCS Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

To set up a raw export pipeline to Google Cloud Storage (GCS) from Mixpanel, you must configure GCS to receive the exported data, then [create a pipeline](https://developer.mixpanel.com/reference/create-warehouse-pipeline) to export the data.

The following document summarizes the steps to edit GCS permissions so that it accepts the Mixpanel export, and provides an example request to create the pipeline.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Schematized AWS Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Mixpanel's [Schematized Export Pipeline](/docs/data-pipelines/old-pipelines/schematized-export-pipeline) lets you export your Mixpanel data directly into an S3 bucket, allowing the use of Glue to query it. To set up the Mixpanel AWS pipeline, you must configure AWS to receive the exported data, then [create a pipeline](https://developer.mixpanel.com/reference/create-warehouse-pipeline) to export the data.

## Design
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Schematized Azure Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Mixpanel’s Azure Blob Export is one type of [Schematized Export Pipeline](/docs/data-pipelines/old-pipelines/schematized-export-pipeline) that exports Mixpanel events and people data and imports them into an Azure Blob storage instance.

Azure Export enables the use of SQL to query your event data, either for expressing new types of queries or for joining against other data already present in your data environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
import { Callout } from 'nextra/components'

# Schematized BigQuery Pipeline

This guide describes how Mixpanel exports your data to a [Google BigQuery](https://cloud.google.com/bigquery/) dataset.
<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

This guide describes how Mixpanel exports your data to a [Google BigQuery](https://cloud.google.com/bigquery/) dataset.

## Design

There are currently two ways to export mixpanel data into BigQuery.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Schematized GCS Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

The Google Cloud Storage schema pipeline exports [transformed data](/docs/data-pipelines/old-pipelines/schematized-export-pipeline#transformation-rules) to a GCS bucket. This can be useful in case you want to export Mixpanel data into your own BigQuery instance.

To set up a schematized export pipeline to Google Cloud Storage (GCS) from Mixpanel, you must configure GCS to receive the exported data, then [create a pipeline](https://developer.mixpanel.com/reference/create-warehouse-pipeline) to export the data.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Schematized Snowflake Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

This guide describes how Mixpanel data is exported into a [Snowflake](https://docs.snowflake.net/manuals/user-guide-getting-started.html) dataset. [Create a pipeline](https://developer.mixpanel.com/reference/create-warehouse-pipeline) to export your Mixpanel data into Snowflake. Once an export job is scheduled, Mixpanel exports data to Snowflake on a recurring basis.

## Design
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { Callout } from 'nextra/components'

# Schematized Export Pipeline

<Callout type="info">
Customers on an Enterprise or Growth plan can access Data Pipeline as an add-on package. See our [pricing page](https://mixpanel.com/pricing/) for more details.
</Callout>

Schematized Export Pipeline is designed to export your Mixpanel data into supported data warehouses or object storage solutions. We first transform the events and user profile data in Mixpanel to be ready to be loaded into the supported data warehouses using [transformation rules](#transformation-rules). For object storage solutions, we only add the mapping of original property names to the column names to the bucket. For data warehouses, we add the schema and time-based partitions to the tables to make the queries easier to write and more efficient.

This documentation targets users with intermediate or advanced knowledge of databases and knowledge of Amazon Web Services, Google Cloud Platform, or Snowflake technology.
Expand Down
Loading

0 comments on commit d765d86

Please sign in to comment.