diff --git a/changelogs.mdx b/changelogs.mdx index fa530c75..4ceeb5bd 100644 --- a/changelogs.mdx +++ b/changelogs.mdx @@ -9,6 +9,21 @@ Get all the latest updates in your inbox. + + ## Destinations: a simpler way to send data out of Mixpanel + + We've reworked the Integrations page to make it easier to create and manage Destinations, Cohort Syncs, and Data Pipelines. + + With this update: + + - **"Integrations" is now "Destinations":** The new name makes the page's purpose clearer — it's for connecting data flowing out of Mixpanel — and reduces confusion for users who came looking for ways to bring data in. + - **Destinations lives in the Data menu:** Find it under **Data → Destinations** in the main nav. It's still available in the settings menu for now, but that entry point will be removed eventually. + - **Onboard cohort syncs directly from Destinations:** No more bouncing between the Integrations page and Lexicon. Open a connected destination, go to the **Syncs** tab, and click **Add Cohort Sync**. Onboarding from Lexicon still works. + - **Separate views for connected and available destinations:** Your connected destinations and the full library are now split, making it easier to see what's already connected and to add something new. + + [Learn more →](/docs/cohort-sync) + + ## Passkeys @@ -763,63 +778,67 @@ Get all the latest updates in your inbox. -## Deprecation Notice: Legacy US-to-EU Data Forwarding ends July 2026 for EU Projects - -> **🚨 UPDATE: July 1, 2026 – US-to-EU Data Forwarding has officially ended.**

-> -> As scheduled, we have sunset US-to-EU data forwarding.
**For EU Projects that still send data to the US, to help you assess the impact, events sent to US endpoints will be temporarily hidden from your UI and Query API endpoints until August 1, 2026.**

-> -> **How events are being filtered**
-> -> [July 1, 2026 - August 1, 2026]: New US->EU Forwarded events have not been deleted. However, they are temporarily hidden from the UI and Query API endpoints if they match all of the following criteria: -> * The event was processed after July 1st (UTC) (`mp_processing_time_ms` > ``). -> * The event was forwarded from the US (`$mp_is_forwarded` is defined). -> -> These events are not deleted — they remain accessible via the Raw Export API during this period, and will be un-hidden on August 1, 2026, so your reporting counts may change at that time.

**Events that are still being sent to the US after August 1, 2026 for EU Projects will not be accepted.**

**If you are affected, please ensure your implementation is updated to point to Mixpanel's EU Servers `api-eu.mixpanel.com` immediately to prevent permanent data loss after August 1, 2026.**

-> -> *Need help or want to opt out? If you wish to opt out of this UI preview and un-hide your forwarded events early, please [contact support](https://mixpanel.com/get-support).* -> -> >⏳ **Note:** Some projects have an extended timeline through **December 31, 2026**. These projects are not affected by the temporary event-hiding described above. If this applies to your project, we've already reached out with a notification. If you did not receive a notification, your deadline is **August 1, 2026**. - -Starting July 2026, we will be sunsetting the legacy automated US-to-EU Data Forwarding process for [EU Data Residency projects](/docs/privacy/eu-residency) to align with data residency best practices and improve ingestion performance. -After this date, data sent to our US Ingestion Servers for EU Data Residency projects will no longer be forwarded, which can result in data loss. - -## Is my project affected? -- **EU Projects created before August 18, 2025: If your implementation sends data to Mixpanel's US Ingestion Servers (`api.mixpanel.com`), you may be affected by this change. Please review the action required below.** -- EU Projects created on or after August 18, 2025: These projects already require direct ingestion to our EU Servers. No action is needed. - -## Required Action for EU Projects sending data to US Servers - -To avoid any disruption to data ingestion for your EU Projects, **please review and update your implementations to use the dedicated Ingestion API EU Subdomain (`api-eu.mixpanel.com`).** This ensures your data is routed directly to its intended destination. - -**Guidance** - -1. **Verify which projects have EU Data Residency:** Navigate to [Organization Settings](/docs/orgs-and-projects/managing-projects#viewing-project-information) > Projects and click into each Project to confirm whether Data Residency is set to EU. -2. **Identify Traffic:** In your EU Project(s), create an Insights Report and break down “All Events” by the API Endpoint (`$mp_api_endpoint` ) event property to determine which Ingestion Servers your events came from. `$mp_api_endpoint=api-eu.mixpanel.com` is EU and `$mp_api_endpoint=api.mixpanel.com` or `api-js.mixpanel.com` is US. -3. **Update and Review Implementation:** If your project has EU Data Residency, please follow the guides below that apply to your setup to ensure your data routes to our EU Servers. - -If you are using Mixpanel’s SDKs, the documentation linked below has instructions on updating your implementation code to EU: -- [Javascript](/docs/tracking-methods/sdks/javascript#eu-data-residency) -- [React Native](/docs/tracking-methods/sdks/react-native#eu-data-residency) -- [Android](/docs/tracking-methods/sdks/android#eu-data-residency) -- [iOS (Objective-C)](/docs/tracking-methods/sdks/ios#eu-data-residency) -- [iOS (Swift)](/docs/tracking-methods/sdks/swift#eu-data-residency) -- [Flutter](/docs/tracking-methods/sdks/flutter#eu-data-residency) -- [Unity](/docs/tracking-methods/sdks/unity#eu-data-residency) -- [Python](/docs/tracking-methods/sdks/python#eu-data-residency) -- [Node.js](/docs/tracking-methods/sdks/nodejs#eu-data-residency) -- [Ruby](/docs/tracking-methods/sdks/ruby#eu-data-residency) -- [PHP](/docs/tracking-methods/sdks/php#eu-data-residency) -- [Go](/docs/tracking-methods/sdks/go#eu-data-residency) -- [Java](/docs/tracking-methods/sdks/java#eu-data-residency) - -If you are using Mixpanel’s Ingestion API Endpoints, Proxy Server, or an Implementation not listed above: -- Please update your Ingestion API Base URL to the [EU Residency Server](/reference/overview): `api-eu.mixpanel.com` - -If you are using Partner Integrations that send data into Mixpanel (e.g., CDPs, Messaging, AB Testing): -- Please contact the Partner’s Support Team for instructions on how to set the integration to point to Mixpanel’s EU Server URL. - -If you have questions about which specific projects we have observed US Traffic on or need further assistance, please don’t hesitate to reach out to [Mixpanel’s Support Team](/docs/response-times#contacting-mixpanel-support). + ## Deprecation Notice: Legacy US-to-EU Data Forwarding ends July 2026 for EU Projects + + > **🚨 UPDATE: July 1, 2026 – US-to-EU Data Forwarding has officially ended.**

+ > + > As scheduled, we have sunset US-to-EU data forwarding.
**For EU Projects that still send data to the US, to help you assess the impact, events sent to US endpoints will be temporarily hidden from your UI and Query API endpoints until August 1, 2026.**

+ > + > **How events are being filtered**
+ > + > \[July 1, 2026 - August 1, 2026\]: New US-\>EU Forwarded events have not been deleted. However, they are temporarily hidden from the UI and Query API endpoints if they match all of the following criteria: + > + > - The event was processed after July 1st (UTC) (`mp_processing_time_ms` \> ``). + > - The event was forwarded from the US (`$mp_is_forwarded` is defined). + > + > These events are not deleted — they remain accessible via the Raw Export API during this period, and will be un-hidden on August 1, 2026, so your reporting counts may change at that time.

**Events that are still being sent to the US after August 1, 2026 for EU Projects will not be accepted.**

**If you are affected, please ensure your implementation is updated to point to Mixpanel's EU Servers `api-eu.mixpanel.com` immediately to prevent permanent data loss after August 1, 2026.**

+ > + > _Need help or want to opt out? If you wish to opt out of this UI preview and un-hide your forwarded events early, please [contact support](https://mixpanel.com/get-support)._ + > + > > ⏳ **Note:** Some projects have an extended timeline through **December 31, 2026**. These projects are not affected by the temporary event-hiding described above. If this applies to your project, we've already reached out with a notification. If you did not receive a notification, your deadline is **August 1, 2026**. + + Starting July 2026, we will be sunsetting the legacy automated US-to-EU Data Forwarding process for [EU Data Residency projects](/docs/privacy/eu-residency) to align with data residency best practices and improve ingestion performance. After this date, data sent to our US Ingestion Servers for EU Data Residency projects will no longer be forwarded, which can result in data loss. + + ## Is my project affected? + + - **EU Projects created before August 18, 2025: If your implementation sends data to Mixpanel's US Ingestion Servers (`api.mixpanel.com`), you may be affected by this change. Please review the action required below.** + - EU Projects created on or after August 18, 2025: These projects already require direct ingestion to our EU Servers. No action is needed. + + ## Required Action for EU Projects sending data to US Servers + + To avoid any disruption to data ingestion for your EU Projects, **please review and update your implementations to use the dedicated Ingestion API EU Subdomain (`api-eu.mixpanel.com`).** This ensures your data is routed directly to its intended destination. + + **Guidance** + + 1. **Verify which projects have EU Data Residency:** Navigate to [Organization Settings](/docs/orgs-and-projects/managing-projects#viewing-project-information) \> Projects and click into each Project to confirm whether Data Residency is set to EU. + 2. **Identify Traffic:** In your EU Project(s), create an Insights Report and break down “All Events” by the API Endpoint (`$mp_api_endpoint` ) event property to determine which Ingestion Servers your events came from. `$mp_api_endpoint=api-eu.mixpanel.com` is EU and `$mp_api_endpoint=api.mixpanel.com` or `api-js.mixpanel.com` is US. + 3. **Update and Review Implementation:** If your project has EU Data Residency, please follow the guides below that apply to your setup to ensure your data routes to our EU Servers. + + If you are using Mixpanel’s SDKs, the documentation linked below has instructions on updating your implementation code to EU: + + - [Javascript](/docs/tracking-methods/sdks/javascript#eu-data-residency) + - [React Native](/docs/tracking-methods/sdks/react-native#eu-data-residency) + - [Android](/docs/tracking-methods/sdks/android#eu-data-residency) + - [iOS (Objective-C)](/docs/tracking-methods/sdks/ios#eu-data-residency) + - [iOS (Swift)](/docs/tracking-methods/sdks/swift#eu-data-residency) + - [Flutter](/docs/tracking-methods/sdks/flutter#eu-data-residency) + - [Unity](/docs/tracking-methods/sdks/unity#eu-data-residency) + - [Python](/docs/tracking-methods/sdks/python#eu-data-residency) + - [Node.js](/docs/tracking-methods/sdks/nodejs#eu-data-residency) + - [Ruby](/docs/tracking-methods/sdks/ruby#eu-data-residency) + - [PHP](/docs/tracking-methods/sdks/php#eu-data-residency) + - [Go](/docs/tracking-methods/sdks/go#eu-data-residency) + - [Java](/docs/tracking-methods/sdks/java#eu-data-residency) + + If you are using Mixpanel’s Ingestion API Endpoints, Proxy Server, or an Implementation not listed above: + + - Please update your Ingestion API Base URL to the [EU Residency Server](/reference/overview): `api-eu.mixpanel.com` + + If you are using Partner Integrations that send data into Mixpanel (e.g., CDPs, Messaging, AB Testing): + + - Please contact the Partner’s Support Team for instructions on how to set the integration to point to Mixpanel’s EU Server URL. + + If you have questions about which specific projects we have observed US Traffic on or need further assistance, please don’t hesitate to reach out to [Mixpanel’s Support Team](/docs/response-times#contacting-mixpanel-support).
@@ -3360,4 +3379,4 @@ If you have questions about which specific projects we have observed US Traffic ## Tell a richer story with text on dashboards You can now add text to dashboards, making it easier to share the context behind your analysis or tell a compelling story around your data. Sometimes, a word is worth a thousand pictures. - + \ No newline at end of file diff --git a/docs.json b/docs.json index 628993e8..f50f9c42 100644 --- a/docs.json +++ b/docs.json @@ -512,7 +512,7 @@ "docs/cohort-sync/webhooks", "docs/cohort-sync/build-an-integration", { - "group": "Integrations", + "group": "Destinations", "root": "docs/cohort-sync/integrations", "pages": [ "docs/cohort-sync/integrations/abtasty", diff --git a/docs/cohort-sync.mdx b/docs/cohort-sync.mdx index aec4ead4..a693e13e 100644 --- a/docs/cohort-sync.mdx +++ b/docs/cohort-sync.mdx @@ -21,36 +21,53 @@ The value of Cohort Sync lies in its ability to bridge analytics and action: you Before you can use Cohort Sync to export Mixpanel cohorts, you must establish a connection between Mixpanel and your Cohort Sync destination. Mixpanel integrates natively with several third-party destinations (such as Segment and Braze). If you need to sync cohorts to a different destination, you can use Custom Webhooks to export cohort payloads to any destination of your choice. -Refer to the Cohort Sync Integration Directory below for partner-specific setup guides, or use the Custom Webhooks guide to export cohorts to destinations without a native integration. +Refer to the Cohort Sync Destination Directory below for partner-specific setup guides, or use the Custom Webhooks guide to export cohorts to destinations without a native integration. - - + + + + + ### Initialize Cohort Sync -Once a connection has been established between your Mixpanel project and your Cohort Sync destination/Webhooks, you can initialize a cohort sync export. - - - - - - - - - - - - -Learn more about the [types of syncs](/docs/cohort-sync/webhooks#sync). - - +Once a connection has been established between your Mixpanel project and your Cohort Sync destination/Webhooks, you can initialize a cohort sync export. The Destinations page is now the primary way to manage cohort syncs; the Lexicon flow is still available. + + + + + + + + + + + + Choose a one-time export or a recurring export. Learn more about the [types of syncs](/docs/cohort-sync/webhooks#sync). + + + + + + + + + + + + + Learn more about the [types of syncs](/docs/cohort-sync/webhooks#sync). + + + + ## Limits - Only customers on a paid plan can save cohorts; therefore, the cohort sync feature is available exclusively to paid plan customers. + Only customers on a paid plan can save cohorts; therefore, the cohort sync feature is available exclusively to paid plan customers. Each project is limited to 60 dynamic (recurring) cohort syncs across all destinations. This limit helps ensure that syncs are fast and reliable. We recommend pruning older unused syncs to stay within the limit. There are no limit on the number of cohorts for static, or 1-time, syncs. @@ -59,7 +76,7 @@ When exporting, each cohort is limited to 10 million users. We do this to keep s The exported user data is limited to the following properties: -``` +```text $distinct_id $first_name $last_name @@ -73,7 +90,7 @@ If these properties are not present in your project, users might not be matched The email address and phone number properties will only show in the manual CSV exports for Google Ads and Facebook integrations. - Exporting group-level cohorts (Group Analytics) is not currently supported. + Exporting group-level cohorts (Group Analytics) is not currently supported. ## Troubleshooting @@ -82,59 +99,64 @@ Sometimes, you may find that the number of users shown in your cohort in Mixpane ### Discrepancies in user count -If you see a discrepancy between the count of your users in a Mixpanel cohort and in the integration partner, the first thing to check is if all your users were eligible to be exported. To match users in both systems, we require a partner ID, e.g. `$braze_external_id` for Braze cohort exports. You can easily confirm this by querying for your cohort in the User report, then adding the filter `$braze_external_id` is set. This will show all eligible users that can be exported from Mixpanel to Braze. +If you see a discrepancy between the count of your users in a Mixpanel cohort and in the integration partner, the first thing to check is if all your users were eligible to be exported. To match users in both systems, we require a partner ID, e.g. `$braze_external_id` for Braze cohort exports. You can easily confirm this by querying for your cohort in the User report, then adding the filter `$braze_external_id` is set. This will show all eligible users that can be exported from Mixpanel to Braze. When accessing the "View in Explore" option, you will see the required partner ID added by default for the following integrations: ABTasty, Airship, Blitzllama, Braze, Clevertap, Flagship, Insider, Iterable, Kameleoon, LaunchDarkly, Leanplum, Moengage, OneSignal, Optimize, Pushwoosh, SalesforceMC, Segment, VWO, Xtremepush -It is also added by default to any integration where the join key is not the \$distinct_id. The added partner ID filter will show up as a [custom property](/docs/features/custom-properties) called "Defined Properties Required for Cohort Selection" whose properties will appear when hovering over the property: +It is also added by default to any integration where the join key is not the \$distinct\_id. The added partner ID filter will show up as a [custom property](/docs/features/custom-properties) called "Defined Properties Required for Cohort Selection" whose properties will appear when hovering over the property: -![image](https://user-images.githubusercontent.com/13734965/233539618-3ac2c97e-d3fd-4c44-8dc3-847ecdfe50bb.png) + ![image](https://user-images.githubusercontent.com/13734965/233539618-3ac2c97e-d3fd-4c44-8dc3-847ecdfe50bb.png) ### Inspect exported cohorts via CSV download -To find out which and how many users have been exported from your cohort to the integration partner, you can now download a CSV containing all users that have been exported. When accessing the cohort export overview by navigating to the integration in your Integrations tab, then clicking on the cohort, you will be navigated to this overview: +To find out which and how many users have been exported from your cohort to the integration partner, you can now download a CSV containing all users that have been exported. When accessing the cohort export overview by navigating to the integration in your Destinations page, then clicking on the cohort, you will be navigated to this overview: -![image](https://user-images.githubusercontent.com/13734965/233539646-5057fdb4-5c15-412a-8390-1bed8d44f136.png) + ![image](https://user-images.githubusercontent.com/13734965/233539646-5057fdb4-5c15-412a-8390-1bed8d44f136.png) -You will find a summary of the total count of users exported and removed and a CSV download button. In the CSV, you can find the list of distinct_ids of the users in the export and an operation column. This operation column can contain one of three values; add when the user profile was newly added to the cohort, remove when the user was removed from the cohort and no-op when the user remains in the cohort. In the column next to the distinct_id, you will see the partner ID for that user. If the numbers between Mixpanel and the integration partner mismatch, you can confirm if a user has been exported by looking at the CSV file. +You will find a summary of the total count of users exported and removed and a CSV download button. In the CSV, you can find the list of distinct\_ids of the users in the export and an operation column. This operation column can contain one of three values; add when the user profile was newly added to the cohort, remove when the user was removed from the cohort and no-op when the user remains in the cohort. In the column next to the distinct\_id, you will see the partner ID for that user. If the numbers between Mixpanel and the integration partner mismatch, you can confirm if a user has been exported by looking at the CSV file. ### Export is paused -If you notice your cohorts are not being exported, you can view the reason for the pause in your Integrations tab. When accessing the integration, you will see the status (either Active or Paused). If the status says Paused, you can hover over the Paused text to see the reason for the pause: +If you notice your cohorts are not being exported, you can view the reason for the pause in your Destinations page. When accessing the integration, you will see the status (either Active or Paused). If the status says Paused, you can hover over the Paused text to see the reason for the pause: -![image](https://user-images.githubusercontent.com/13734965/233539691-d36370b1-880a-4aa6-a64c-399175c02388.png) + ![image](https://user-images.githubusercontent.com/13734965/233539691-d36370b1-880a-4aa6-a64c-399175c02388.png) -Some integrations have common pause reasons (e.g. [Facebook's authentication pause](/docs/cohort-sync/integrations/facebook-ads#troubleshooting-errors)). You can usually resolve the paused reason on your side by confirming the authorization for the integration is still valid, and dis- and reconnecting. +Some integrations have common pause reasons (e.g. [Facebook's authentication pause](/docs/cohort-sync/integrations/facebook-ads#troubleshooting-errors)). You can usually resolve the paused reason on your side by confirming the authorization for the integration is still valid, and dis- and reconnecting. ### View sync error -To find more details on Failure errors, you can click in the Cohort within the Integrations page to display errors. +To find more details on Failure errors, you can click in the Cohort within the Destinations page to display errors. 1. Under the integration section, select the cohort: + -![image](https://user-images.githubusercontent.com/13734965/233539867-3bd94f9f-b50c-4939-9eb9-5879e0b2e8cf.png) + ![image](https://user-images.githubusercontent.com/13734965/233539867-3bd94f9f-b50c-4939-9eb9-5879e0b2e8cf.png) + 2. If an error is available, you will see the “View Error” button: + -![image](https://user-images.githubusercontent.com/13734965/233539900-58b14423-bdfd-4fb7-98ff-17576d54a5d8.png) + ![image](https://user-images.githubusercontent.com/13734965/233539900-58b14423-bdfd-4fb7-98ff-17576d54a5d8.png) + 3. Click on the “View Error” button to get more details. Currently the “View Error” button will only display if there is an error available. In the case that you do not see a “View Error” button but the sync did not finish successfully, you can reach out to the Support team to help get more details on the error. ### Delay in Sync + If your recurring cohort syncs are taking more time than expected, we recommend creating multiple connections and spreading your syncs across them. Cohort syncs under one connection are executed in a sequential order; to increase parallelism, you should create multiple connections covering different types of sync. In general, if you see the cumulative user count of all cohorts synced under a connection breach ~5 million, we would recommend that you create a new connection. -![image](/images/cohort_sync_delay.png) - + ![image](/images/cohort_sync_delay.png) + \ No newline at end of file diff --git a/docs/cohort-sync/integrations.mdx b/docs/cohort-sync/integrations.mdx index f6cd9582..f5e097fd 100644 --- a/docs/cohort-sync/integrations.mdx +++ b/docs/cohort-sync/integrations.mdx @@ -1,6 +1,6 @@ --- -sidebarTitle: "Integrations" -title: "Integrations: Export your cohorts to a third-party tool" +sidebarTitle: "Destinations" +title: "Destinations: Export your cohorts to a third-party tool" --- @@ -13,7 +13,7 @@ title: "Integrations: Export your cohorts to a third-party tool" These integrations allow you to send your [Cohorts](/docs/users/cohorts) to other destinations for audience targeting. You may review our complete integrations directory [here](https://mixpanel.com/partners/integrations). If you don't see what you're looking for [reach out to us](https://mixpanel.com/get-support). -## Featured Integrations +## Featured Destinations diff --git a/docs/cohort-sync/integrations/abtasty.mdx b/docs/cohort-sync/integrations/abtasty.mdx index 98120e70..44ce07c2 100644 --- a/docs/cohort-sync/integrations/abtasty.mdx +++ b/docs/cohort-sync/integrations/abtasty.mdx @@ -2,7 +2,6 @@ title: "AB Tasty" --- - ## Overview The Mixpanel and AB Tasty integration provides a bidirectional data sync, allowing you to export Mixpanel cohorts to AB Tasty for precise experiment targeting and import AB Tasty experiment data into Mixpanel for comprehensive behavior analysis. This seamless exchange enhances your ability to analyze, segment, and personalize user experiences. @@ -24,15 +23,13 @@ Admin Access: You need admin-level permissions in AB Tasty to configure and enab ### Mixpanel Setup -1. Navigate to **Settings** in the bottom left, then select **Integrations**. -2. In the Integrations list, select AB Tasty, and click Connect. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select AB Tasty, and click Connect. 3. To set up the AB Tasty integration, you need to enter your account’s API Key. Copy and paste the API Key of your AB Tasty account. Click Continue. - - ### In AB Tasty -1. Access Integrations > Integration Hub. +1. Access Integrations \> Integration Hub. 2. Search for and select Mixpanel. 3. Click Setup connector. 4. Give a name to your connector so you can easily retrieve it. @@ -42,17 +39,26 @@ Admin Access: You need admin-level permissions in AB Tasty to configure and enab To export the cohorts to AB Tasty, follow the steps below: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. -2. Select the cohort that you want to export. Click the three-dot icon on the right side of the cohort. -3. Click Export to > AB Tasty. Select either one-time sync or dynamic sync. Click Start Sync. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the AB Tasty destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click the three-dot icon on the right side of the cohort. + 3. Click Export to \> AB Tasty. Select either one-time sync or dynamic sync. Click Start Sync. + + AB Tasty Documentation on cohorts exports from Mixpanel is [here](https://support.abtasty.com/hc/en-us/articles/7305491216924-Mixpanel) - Mixpanel sends the cohorts every 15 minutes in case of recurring exports -- AB tasty pushes the abtasty_visitor_id to Mixpanel, and Mixpanel includes it in the cohort export. The abtasty_visitor_id is used to match the user. +- AB tasty pushes the abtasty\_visitor\_id to Mixpanel, and Mixpanel includes it in the cohort export. The abtasty\_visitor\_id is used to match the user. - For the cohorts to be used in AB Tasty’s segment builder (once exported from Mixpanel), we need to match at least one user i.e. empty cohorts will not be displayed in the segment builder. - ## AB Tasty Events in Mixpanel Analyze your AB Tasty experiments in Mixpanel with a powerful, streamlined workflow. By creating two simple custom properties and configuring your project's Experiment Settings, you can access AB Tasty data in dropdowns, breakdowns, and experimentation reports. This one-time setup eliminates the need for complex, report-by-report data parsing and unlocks a more powerful and consistent way to measure the impact of your A/B tests. @@ -68,36 +74,38 @@ Before configuring the Experiment Settings, you must first parse the campaign an Navigate to **Lexicon** in your Mixpanel project and create the two custom properties below. #### A. Campaign Custom Property + -![Screenshot 2025-06-17 at 1 49 40 PM](https://github.com/user-attachments/assets/add85567-80d5-4a11-b05c-0934a5365b28) + ![Screenshot 2025-06-17 at 1 49 40 PM](https://github.com/user-attachments/assets/add85567-80d5-4a11-b05c-0934a5365b28) This property uses a REGEX function to extract the campaign name. -1. **Create a new Custom Property.** -2. Name it. `AB Tasty Campaign Name` is recommended, but the name does not need to exactly match this format. -3. Use the following formula: - ``` - REGEX_EXTRACT(properties["AB Tasty"], "^\\[\\d+\\](.*?)(?=\\[\\d+\\])", 1) - ``` -4. **Save** the property. +1. **Create a new Custom Property.** +2. Name it. `AB Tasty Campaign Name` is recommended, but the name does not need to exactly match this format. +3. Use the following formula: + ```text + REGEX_EXTRACT(properties["AB Tasty"], "^\\[\\d+\\](.*?)(?=\\[\\d+\\])", 1) + ``` +4. **Save** the property. -> **How it works:** This formula reads the `"AB Tasty"` property and extracts only the text that exists *between* the first and second ID brackets (e.g., `[12345]` and `[67890]`). +> **How it works:** This formula reads the `"AB Tasty"` property and extracts only the text that exists _between_ the first and second ID brackets (e.g., `[12345]` and `[67890]`). #### B. Variation Custom Property + -![Screenshot 2025-06-17 at 1 49 16 PM](https://github.com/user-attachments/assets/fd48158a-a436-48bc-9d2b-f4cb9931f2e6) + ![Screenshot 2025-06-17 at 1 49 16 PM](https://github.com/user-attachments/assets/fd48158a-a436-48bc-9d2b-f4cb9931f2e6) This property uses a nested SPLIT function to isolate the variation name. -1. **Create another new Custom Property.** -2. Name it. `AB Tasty Variant Name` is recommended, but the name does not need to exactly match this format. -3. Use the following formula: - ``` - SPLIT(SPLIT(properties["AB Tasty"], "[", 3), "]", 1) - ``` -4. **Save** the property. +1. **Create another new Custom Property.** +2. Name it. `AB Tasty Variant Name` is recommended, but the name does not need to exactly match this format. +3. Use the following formula: + ```text + SPLIT(SPLIT(properties["AB Tasty"], "[", 3), "]", 1) + ``` +4. **Save** the property. > **How it works:** This formula first splits the full string by the `[` character to isolate the end of the string, and then splits that result by the `]` character to capture only the variation name. @@ -106,22 +114,23 @@ This property uses a nested SPLIT function to isolate the variation name. With your Custom Properties created, you can now tell Mixpanel how to recognize your AB Tasty experiments. -![image](https://github.com/user-attachments/assets/4384ed79-79d8-4035-8ffe-35550a0835e1) + ![image](https://github.com/user-attachments/assets/4384ed79-79d8-4035-8ffe-35550a0835e1) -1. Navigate to your **Project Settings**. -2. Scroll to the **Experiment Event Settings** section. -3. Define the mapping for your AB Tasty experiments: - * **Experiment Event**: Select the `"Event"` event. - * **Experiment Name**: Map this to your new custom property, `AB Tasty Campaign Name`. - * **Variant Name**: Map this to your new custom property, `AB Tasty Variation Name`. -4. **Save** your settings. +1. Navigate to your **Project Settings**. +2. Scroll to the **Experiment Event Settings** section. +3. Define the mapping for your AB Tasty experiments: + - **Experiment Event**: Select the `"Event"` event. + - **Experiment Name**: Map this to your new custom property, `AB Tasty Campaign Name`. + - **Variant Name**: Map this to your new custom property, `AB Tasty Variation Name`. +4. **Save** your settings. ### The Result: Powerful, Automated Analysis Once saved, Mixpanel will automatically process all incoming AB Tasty data according to your settings. You can now analyze your experiments without any further configuration. This provides several key advantages: -* No more ad-hoc filtering or complex formulas in your reports. -* Consistent, reliable analysis across all of your AB Tasty experiments. -* Unlock the full power of Mixpanel's Experimentation features, including significance testing and impact on multiple goals. + +- No more ad-hoc filtering or complex formulas in your reports. +- Consistent, reliable analysis across all of your AB Tasty experiments. +- Unlock the full power of Mixpanel's Experimentation features, including significance testing and impact on multiple goals. \ No newline at end of file diff --git a/docs/cohort-sync/integrations/airship.mdx b/docs/cohort-sync/integrations/airship.mdx index 436930c1..f9d6e048 100644 --- a/docs/cohort-sync/integrations/airship.mdx +++ b/docs/cohort-sync/integrations/airship.mdx @@ -2,7 +2,6 @@ title: "Airship" --- - ## Overview The Airship integration with Mixpanel allows users to export Mixpanel cohorts into Airship. This updates the Mixpanel Tag Group in Airship, allowing you to target specific Mixpanel cohorts using Airship. Mixpanel cohorts can be exported to the Airship Tag Group once, or the cohort data can sync dynamically and update the Tag Group every 15 minutes. @@ -14,19 +13,19 @@ You must be a Mixpanel project admin to enable the Airship integration. If the setting below is enabled in Airship, you will see the error "Master secret required to set tags on Tag Group mixpanel" in Mixpanel. Work with Airship to disable this setting so Mixpanel can update the Airship tag group. -![Airship 1 Image](/images/airship1.png) + ![Airship 1 Image](/images/airship1.png) ## Enable the Integration In order to integrate Airship with Mixpanel for anonymous mobile audience identification, you will first need to install both the [Airship SDK](https://docs.urbanairship.com/platform/) and Mixpanel SDK in your application. Once you have done so, follow these steps: -1. Navigate to **Settings** in the bottom left, then select **Integrations**. Go to the Airship Integrations User Interface and enter the [Airship All Access Token and App Key](https://docs.airship.com/guides/messaging/user-guide/project/bearer-tokens/), which allows Mixpanel to send data to the correct Airship project. +1. Navigate to **Data** in the nav bar, then select **Destinations**. Click **Add Destination**, then select Airship and enter the [Airship All Access Token and App Key](https://docs.airship.com/guides/messaging/user-guide/project/bearer-tokens/), which allows Mixpanel to send data to the correct Airship project. 2. Create a cohort in Mixpanel. 3. Create a Mixpanel [Tag Group within Airship](https://docs.urbanairship.com/guides/tag-groups-walkthrough/#tg-create-tag-group). **For this Integration, we require that you create a Tag Group Key called "mixpanel". Note that Tag Group Keys are case sensitive.** 4. Export the Cohort from Mixpanel, at which time Mixpanel will wait for a callback to ensure that the request to Airship was received. - - A **one-time export** will add the new Airship tag to all users in the Mixpanel cohort at the time of the export. The new tag will be visible in Airship. - - A **dynamic sync** will add or remove a tag for users in the cohort every 15 minutes until the sync is disconnected. This means that every 15 minutes, the tag in Airship will update to reflect the current status of the Mixpanel cohort. + - A **one-time export** will add the new Airship tag to all users in the Mixpanel cohort at the time of the export. The new tag will be visible in Airship. + - A **dynamic sync** will add or remove a tag for users in the cohort every 15 minutes until the sync is disconnected. This means that every 15 minutes, the tag in Airship will update to reflect the current status of the Mixpanel cohort. ## How does Mixpanel export data to Airship? @@ -37,40 +36,50 @@ _It is not recommended to use the same tag name for two static exports, as users **For dynamically syncing exports:** Every 15 minutes, Mixpanel will initiate a sync between the Mixpanel cohort and the Airship tag. At the time of the sync, Mixpanel will add the tag for newly-qualified users, and remove the tag for users who have exited the cohort. Users can move into and out of the cohort depending on if they meet the cohort criteria. Note that these tags only apply to the “mixpanel” Tag Group Key, which must be created within Airship. ## How are users matched between Airship and Mixpanel? -> **Warning:** Projects using the [simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the \$user_id in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the below section are primarily applicable to projects on the original ID merge system. + +> **Warning:** Projects using the [simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the \$user\_id in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the below section are primarily applicable to projects on the original ID merge system. Users are matched between Airship and Mixpanel using the [Airship channel id](https://docs.airship.com/guides/airship/user-guide/channels-intro/#channel-ids). This value must be set as a Mixpanel user property named `$ios_urban_airship_channel_id` for iOS users or `$android_urban_airship_channel_id` for Android users. These values must match with the Airship channel id. - + The recommendation would be to insert code after the user authenticates that sends a `people.set` operation to the `$android_urban_airship_channel_id` and `$ios_urban_airship_channel_id` properties respectively as string values, so they are stored in the Mixpanel profile. This could be when they sign up (or just log in if they already had an account). By setting the property each time the user authenticates you would ensure users who have signed up previous to this code changes also have it. ->**Note:** SDK versions older than Android v5.9.6, Swift: v2.10.4, and Objective-C: v3.9.2 automatically created these properties. This has since been removed in favor of them being set according to your user's flow. +> **Note:** SDK versions older than Android v5.9.6, Swift: v2.10.4, and Objective-C: v3.9.2 automatically created these properties. This has since been removed in favor of them being set according to your user's flow. **Additionally**, exports will send all user profiles to match against [Airship's Named User system](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/named-users/), which handles cross-platform identification. If you would like to specify a value to match a Mixpanel user profile to a Named User, **you must add a user property, `$airship_named_user`**, which will be sent to attempt matching (note you must set this value, the Airship SDK will not automatically declare it). -Users without `$airship_named_user` user properties will instead have their distinct_id sent to Airship's Named User system - this route is intended for implementations where the same identifier value is used for both distinct_id (Mixpanel) and named_user_id (Airship). Note that for customers using identity merge, Mixpanel will send the [canonical distinct ID](https://help.mixpanel.com/hc/en-us/articles/360041039771-Getting-Started-with-Identity-Management#individual-users), which may change over time. To ensure a consistent identifier is sent to Airship's Named User system, add the `$airship_named_user` property to the user's profile. +Users without `$airship_named_user` user properties will instead have their distinct\_id sent to Airship's Named User system - this route is intended for implementations where the same identifier value is used for both distinct\_id (Mixpanel) and named\_user\_id (Airship). Note that for customers using identity merge, Mixpanel will send the [canonical distinct ID](https://help.mixpanel.com/hc/en-us/articles/360041039771-Getting-Started-with-Identity-Management#individual-users), which may change over time. To ensure a consistent identifier is sent to Airship's Named User system, add the `$airship_named_user` property to the user's profile. ## Sending Mixpanel Cohorts to Airship -To export the cohorts to AB Tasty, follow the steps below: +To export cohorts to Airship, follow the steps below: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Airship destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and enter the Airship Tag under which the export should be saved. Configure the sync and click **Save**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select your cohort and click **Export to... \> Airship**. -2. Select your cohort and click **Export to... > Airship**. - - -![Airship 2 Image](/images/airship2.png) - + + ![Airship 2 Image](/images/airship2.png) + -3. Enter the Airship Tag under which the export should be saved. Click **Save**. + 3. Enter the Airship Tag under which the export should be saved. Click **Save**. + + -![Airship 3 Image](/images/airship3.png) + ![Airship 3 Image](/images/airship3.png) 4. The tag will now be available for targeting within Airship. -![Airship 4 Image](/images/airship4.png) + ![Airship 4 Image](/images/airship4.png) ## FAQ @@ -102,9 +111,4 @@ The following events are exempt from MTU calculations: - Airship Send Rejected - Airship Unsubscribe - Airship SMS Delivered -- Airship Email Injection - - - - - +- Airship Email Injection \ No newline at end of file diff --git a/docs/cohort-sync/integrations/appcues.mdx b/docs/cohort-sync/integrations/appcues.mdx index fd1c2184..cfaecbfa 100644 --- a/docs/cohort-sync/integrations/appcues.mdx +++ b/docs/cohort-sync/integrations/appcues.mdx @@ -2,10 +2,9 @@ title: "Appcues" --- - ## Overview -Export Mixpanel cohorts to Appcues to create custom segments that you can apply in your Appcues flows, surveys, and walkthroughs. Manage the Appcues integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Appcues to create custom segments that you can apply in your Appcues flows, surveys, and walkthroughs. Manage the Appcues integration from the Mixpanel Destinations page. Appcues also supports an integration to send messaging interactions to Mixpanel - for more details, see [the Appcues Mixpanel integration](https://docs.appcues.com/article/447-integrations-list#Mixpanel). @@ -17,35 +16,41 @@ You must be a Mixpanel project admin to enable the Appcues integration. Follow these steps to enable the integration with Appcues: -1. Navigate to **Settings** in the bottom left, then select **Integrations**. - -2. From the Integrations page, select the Appcues dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Appcues, and click **Connect**. -![Appcues 2 Image](/images/appcues2.png) + ![Appcues 2 Image](/images/appcues2.png) 3. The connection uses one credential to authorize, API Key. Supply an **API token** generated from your **Appcues settings page** to establish the connection. - -3. The Appcues integration will show a **Connected** tag in the UI once the connection establishes. +4. The Appcues integration will show a **Connected** tag in the UI once the connection establishes. ## Matching Users between Appcues and Mixpanel Mixpanel only exports identified user profiles (users with at least 1 set profile properties) to match to Appcues - users without user profiles (i.e. anonymous users) will not export. -The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to `appcues.identify("internal_user_id")`. Appcues will attempt to match users from inbound cohorts based on their Mixpanel distinct_id. +The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to `appcues.identify("internal_user_id")`. Appcues will attempt to match users from inbound cohorts based on their Mixpanel distinct\_id. ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > Appcues. Select either one-time sync or dynamic sync. Click **Start Sync**. - - -![Appcues 3 Image](/images/appcues3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Appcues destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> Appcues. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![Appcues 3 Image](/images/appcues3.png) + + + ## Sync Types @@ -70,14 +75,9 @@ More ideal use cases are instead around tours and surveys where the tour isn't t Once the export completes, you will see a Segment reflecting the set of users from your Mixpanel cohort in the Appcues Segment tab, under Custom Properties in the dropdown (e.g. "Volume Buyers"): -![Appcues 4 Image](/images/appcues4.png) + ![Appcues 4 Image](/images/appcues4.png) ## Appcues events into Mixpanel -Appcues offers the ability to forward tour interaction events to Mixpanel. For more detail, [please refer to the Appcues integration guide](https://docs.appcues.com/article/447-integrations-list#Mixpanel). - - - - - +Appcues offers the ability to forward tour interaction events to Mixpanel. For more detail, [please refer to the Appcues integration guide](https://docs.appcues.com/article/447-integrations-list#Mixpanel). \ No newline at end of file diff --git a/docs/cohort-sync/integrations/apptimize.mdx b/docs/cohort-sync/integrations/apptimize.mdx index 912d8e01..37565abc 100644 --- a/docs/cohort-sync/integrations/apptimize.mdx +++ b/docs/cohort-sync/integrations/apptimize.mdx @@ -2,10 +2,9 @@ title: "Apptimize" --- - ## Overview -The Apptimize integration allows users to export Mixpanel cohorts into Apptimize groups, allowing you to target specific users using Apptimize. +The Apptimize integration allows users to export Mixpanel cohorts into Apptimize groups, allowing you to target specific users using Apptimize. Mixpanel cohorts can be exported to Apptimize one time, or sync and update every 15 minutes. @@ -17,18 +16,17 @@ You must be a Mixpanel project admin to enable the Apptimize integration. Follow these steps to enable the integration with Apptimize: -1. Navigate to **Settings** in the bottom left, then select **Integrations**. - -2. From the Integrations page, select the Apptimize dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Apptimize, and click **Connect**. -![Apptimize 2 Image](/images/apptimize2.png) + ![Apptimize 2 Image](/images/apptimize2.png) 3. You will need to provide an Apptimize Token (generated from the Apptimize dashboard) to authorize the connection. To generate an Apptimize token, go to the Tokens page on Apptimize Dashboard and click “New Token”. Give the token a memorable name and click Generate. -![Apptimize 3 Image](/images/apptimize3.png) + ![Apptimize 3 Image](/images/apptimize3.png) 4. Use the Apptimize token to authorize the Mixpanel integration. @@ -39,28 +37,38 @@ Follow these steps to enable the integration with Apptimize: Mixpanel only exports identified user profiles (users with at least 1 set profile properties) to match to Apptimize - users without user profiles (i.e. anonymous users) will not export. -The exported users are properly mapped in Apptimize automatically by the integration through the setting of `$apptimize_user_id` user property. This property is set automatically when both the Apptimize and Mixpanel SDKs are installed on the client. +The exported users are properly mapped in Apptimize automatically by the integration through the setting of `$apptimize_user_id` user property. This property is set automatically when both the Apptimize and Mixpanel SDKs are installed on the client. -In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$apptimize_user_id` to the user's distinct_id. This ensures that experiment data passed from Apptimize to Mixpanel still attributes to the correct user. +In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$apptimize_user_id` to the user's distinct\_id. This ensures that experiment data passed from Apptimize to Mixpanel still attributes to the correct user. -> **Note:** Mixpanel users can be associated with Apptimize users manually by setting the \$apptimize_user_id in Mixpanel with the Apptimize.getPartnerID method available in the Apptimize SDK. Do this if ThirdPartyImporting is disabled in Apptimize or when using the Mixpanel Swift SDK, which does not support ThirdPartyImporting. It is important to note that the Apptimize.getParterID will return a modified variation of the customer user ID by prefixing "i_" or "a_" to represent if the ID is identified or anonymous, and will allow Apptimize to properly match users from Mixpanel cohorts. +> **Note:** Mixpanel users can be associated with Apptimize users manually by setting the \$apptimize\_user\_id in Mixpanel with the Apptimize.getPartnerID method available in the Apptimize SDK. Do this if ThirdPartyImporting is disabled in Apptimize or when using the Mixpanel Swift SDK, which does not support ThirdPartyImporting. It is important to note that the Apptimize.getParterID will return a modified variation of the customer user ID by prefixing "i\_" or "a\_" to represent if the ID is identified or anonymous, and will allow Apptimize to properly match users from Mixpanel cohorts. ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > Apptimize. Select either one-time sync or dynamic sync. Click Start Sync. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Apptimize destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> Apptimize. Select either one-time sync or dynamic sync. Click Start Sync. + + ## Sync Types This integration supports two types of exports: one-time export and recurring syncs. When you generate a one-time export or recurring sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Apptimize a static export of users who currently qualify for the cohort. The cohort data will not be updated in Apptimize after a one-time export. ### Recurring Sync + In recurring sync, Mixpanel initiates sync between a cohort and Apptimize every 15 minutes. The exported cohort will be updated every fifteen minutes to reflect the most recent list of users in a cohort. ## Observe the Audience in Apptimize @@ -68,5 +76,5 @@ In recurring sync, Mixpanel initiates sync between a cohort and Apptimize every Once the export completes, you will see your cohorts appear in your Apptimize Groups page. -![Apptimize 4 Image](/images/apptimize4.png) - + ![Apptimize 4 Image](/images/apptimize4.png) + \ No newline at end of file diff --git a/docs/cohort-sync/integrations/braze.mdx b/docs/cohort-sync/integrations/braze.mdx index abca8b21..ef407045 100644 --- a/docs/cohort-sync/integrations/braze.mdx +++ b/docs/cohort-sync/integrations/braze.mdx @@ -4,7 +4,7 @@ title: "Braze" ## Overview -The Mixpanel Braze integration exports Mixpanel Cohorts into [Braze](https://www.braze.com/). This allows you to send Braze campaign messages to targeted cohorts that are created in Mixpanel. You can also send your Braze events into Mixpanel to apply deeper analysis. +The Mixpanel Braze integration exports Mixpanel Cohorts into [Braze](https://www.braze.com/). This allows you to send Braze campaign messages to targeted cohorts that are created in Mixpanel. You can also send your Braze events into Mixpanel to apply deeper analysis. ## Permissions @@ -14,40 +14,39 @@ You must be a Mixpanel project admin to enable the Braze integration. In order to set up the integration, you must use a Data Import Key and a Braze Instance URL to connect a Mixpanel instance with a Braze instance. -A Braze project stores the Data Import Key and Braze Instance URL. You can find these two values in from within Braze. [Use the Braze documentation to learn how to obtain the Key and URL](https://www.braze.com/docs/partners/data_and_infrastructure_agility/analytics/mixpanel_for_currents/). +A Braze project stores the Data Import Key and Braze Instance URL. You can find these two values in from within Braze. [Use the Braze documentation to learn how to obtain the Key and URL](https://www.braze.com/docs/partners/data_and_infrastructure_agility/analytics/mixpanel_for_currents/). ## Set Up the Integration Enter the Mixpanel project where the integration is to be performed, then: -1. Navigate to **Settings** in the bottom left, then select **Integrations**. - -2. Select the Braze integration tab. Click **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, then select **Braze**. Click **Connect**. - If you set a User ID Property, it should be a Mixpanel user property that matches the Braze External ID. If you do not select one, Mixpanel will default to using the `$braze_external_id` property to match users between Braze and Mixpanel. See more about [matching users between Braze and Mixpanel](/docs/cohort-sync/integrations/braze#matching-mixpanel-and-braze-users). + If you set a User ID Property, it should be a Mixpanel user property that matches the Braze External ID. If you do not select one, Mixpanel will default to using the `$braze_external_id` property to match users between Braze and Mixpanel. See more about [matching users between Braze and Mixpanel](/docs/cohort-sync/integrations/braze#matching-mixpanel-and-braze-users). -![Braze 2 Image](/images/braze2.png) + ![Braze 2 Image](/images/braze2.png) If you've set up a Connection already, you have the option of reconnecting the existing Connection. -![Braze 3 Image](/images/braze3.png) + ![Braze 3 Image](/images/braze3.png) -You also have the option of adding a new Connection by clicking the dropdown on the left hand side of the row, and clicking "**+ Add Connection**". +You also have the option of adding a new Connection by clicking the dropdown on the left hand side of the row, and clicking "**\+ Add Connection**". -![Braze 4 Image](/images/braze4.png) + ![Braze 4 Image](/images/braze4.png) 3. Enter the Data Import Key and select a Braze Instance. Note Braze hosts their application on [multiple clusters throughout the US and EU](https://www.braze.com/docs/partners/isv_partners/cohort_import/). -![Braze 5 Image](/images/braze5.png) + ![Braze 5 Image](/images/braze5.png) 4. Click **Continue** to complete the process. @@ -56,23 +55,33 @@ You also have the option of adding a new Connection by clicking the dropdown on To export a Mixpanel cohort, you must create a cohort. To export a Mixpanel cohort to Braze: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Braze destination in the list and click on it. If you have multiple Connections, they will be differentiated by the Connection Name. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort to send to Braze and configure the sync (One-time export or Dynamic sync). Click **Begin Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -![Braze 6 Image](/images/braze6.png) - + + ![Braze 6 Image](/images/braze6.png) + -2. Select the cohort to send to Braze. Select **Export to Braze**. If you have multiple Connections, they will be differentiated by the Connection Name in the parentheses after the Integration Name. + 2. Select the cohort to send to Braze. Select **Export to Braze**. If you have multiple Connections, they will be differentiated by the Connection Name in the parentheses after the Integration Name. - -![Braze 7 Image](/images/braze7.png) - + + ![Braze 7 Image](/images/braze7.png) + -3. Select a One-time export or a Dynamic sync. Click Begin Sync. + 3. Select a One-time export or a Dynamic sync. Click Begin Sync. - -![Braze 8 Image](/images/braze8.png) - + + ![Braze 8 Image](/images/braze8.png) + + + ## Use the Mixpanel Cohort to Create a Segment in Braze @@ -83,37 +92,37 @@ In order to build a Braze Segment after importing a cohort: 1. Select **Segments** tab under **Engagement**. -![Braze 9 Image](/images/braze9.png) + ![Braze 9 Image](/images/braze9.png) 2. Click **Create Segment**. -![Braze 10 Image](/images/braze10.png) + ![Braze 10 Image](/images/braze10.png) 3. After naming the Segment, click Select Filter from the dropdown. -![Braze 11 Image](/images/braze11.png) + ![Braze 11 Image](/images/braze11.png) 4. Select "Mixpanel Cohorts". -![Braze 12 Image](/images/braze12.png) + ![Braze 12 Image](/images/braze12.png) 5. Select the “includes” value from the dropdown. Click **Search for a value** from the dropdown. -![Braze 13 Image](/images/braze13.png) + ![Braze 13 Image](/images/braze13.png) 6. The exported Mixpanel cohort is visible in the dropdown. Select the cohort. -![Braze 14 Image](/images/braze14.png) + ![Braze 14 Image](/images/braze14.png) 7. Click Save. @@ -121,17 +130,17 @@ In order to build a Braze Segment after importing a cohort: ## Matching Mixpanel and Braze Users - **Warning:** Projects using the [Simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the `$user_id` in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the below section are primarily applicable to projects on the original ID merge system. + **Warning:** Projects using the [Simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the `$user_id` in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the below section are primarily applicable to projects on the original ID merge system. -In order to match Mixpanel users to ones on Braze's end, the user in Mixpanel should have a profile property named \$braze_external_id with the value you have assigned in Braze to the same user as [external_user_id](https://www.braze.com/docs/developer_guide/platform_integration_guides/legacy_sdks/ios/analytics/setting_user_ids/#suggested-user-id-naming-convention). +In order to match Mixpanel users to ones on Braze's end, the user in Mixpanel should have a profile property named \$braze\_external\_id with the value you have assigned in Braze to the same user as [external\_user\_id](https://www.braze.com/docs/developer_guide/platform_integration_guides/legacy_sdks/ios/analytics/setting_user_ids/#suggested-user-id-naming-convention). The recommendation would be to insert code after the user authenticates that sends a `people.set` operation to the `$braze_external_id` property with the string value so it is stored in the Mixpanel profile. This could be when they sign up (or just log in if they already had an account). By setting the property each time the user authenticates you would ensure users who have signed up previous to this code changes also have it. -If you are planning to also enable sending engagement events from Braze to Mixpanel, and the Braze external_user_id differs from the user_id you identify the user with in Mixpanel, you can also alias the Braze external_user_id to the distinct_id you identify users with after they authenticate. Often times, you use the same user ID for both the external_user_id in Braze, and the ID you identify with in Mixpanel, so in that case, aliasing would not be needed. +If you are planning to also enable sending engagement events from Braze to Mixpanel, and the Braze external\_user\_id differs from the user\_id you identify the user with in Mixpanel, you can also alias the Braze external\_user\_id to the distinct\_id you identify users with after they authenticate. Often times, you use the same user ID for both the external\_user\_id in Braze, and the ID you identify with in Mixpanel, so in that case, aliasing would not be needed. - SDK versions older than Android v5.9.6, Swift: v2.10.4, and Objective-C: v3.9.2 automatically created both the profile property and the alias mentioned above. This has since been deprecated due to possible ID management issues in some use cases, so on the SDK versions cited (or above), you should set the `$braze_external_id` profile property and alias when applicable. + SDK versions older than Android v5.9.6, Swift: v2.10.4, and Objective-C: v3.9.2 automatically created both the profile property and the alias mentioned above. This has since been deprecated due to possible ID management issues in some use cases, so on the SDK versions cited (or above), you should set the `$braze_external_id` profile property and alias when applicable. ## Braze Events into Mixpanel & MTU exemptions @@ -160,11 +169,10 @@ The following events are exempt from MTU calculations: - SMS Rejection - SMS Send to Carrier - ## Comparing Metrics Braze can be configured to push events to Mixpanel on actions ([review full list of events on Braze's docs](https://www.braze.com/docs/partners/data_and_infrastructure_agility/analytics/mixpanel_for_currents/#supported-currents-events)). A consideration to have is that both platforms can present measurements in different ways (although it's based on the same underlying data). -For uniques specially, on the Mixpanel side, this is calculated based on the unique distinct_id values (unique user IDs) that the events are related to. This can differ on Braze; as an example, unique email opens are measured on the unique number of users/devices that opened the message on a 7-day range (so a user opening the email twice, 2 weeks apart could be considered 2 uniques). +For uniques specially, on the Mixpanel side, this is calculated based on the unique distinct\_id values (unique user IDs) that the events are related to. This can differ on Braze; as an example, unique email opens are measured on the unique number of users/devices that opened the message on a 7-day range (so a user opening the email twice, 2 weeks apart could be considered 2 uniques). -You can reference Braze's calculations [on their docs](https://www.braze.com/docs/user_guide/message_building_by_channel/email/reporting_and_analytics/analytics_glossary#:~:text=The%20total%20number%20of%20delivered%20emails%20that%20have%20been%20opened%20by%20a%20single%20user%20or%20machine%20at%20least%20once.%20This%20is%20tracked%20over%20a%207%20day%20period%20for%20Email) to understand the differences you can see in reporting. +You can reference Braze's calculations [on their docs](https://www.braze.com/docs/user_guide/message_building_by_channel/email/reporting_and_analytics/analytics_glossary#:~:text=The%20total%20number%20of%20delivered%20emails%20that%20have%20been%20opened%20by%20a%20single%20user%20or%20machine%20at%20least%20once.%20This%20is%20tracked%20over%20a%207%20day%20period%20for%20Email) to understand the differences you can see in reporting. \ No newline at end of file diff --git a/docs/cohort-sync/integrations/chameleon.mdx b/docs/cohort-sync/integrations/chameleon.mdx index 7f3b418e..20e04fd6 100644 --- a/docs/cohort-sync/integrations/chameleon.mdx +++ b/docs/cohort-sync/integrations/chameleon.mdx @@ -2,10 +2,9 @@ title: "Chameleon" --- - ## Overview -Export Mixpanel cohorts to Chameleon to create custom segments that you can apply in your Chameleon tours, surveys, and launchers. Manage the Chameleon integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Chameleon to create custom segments that you can apply in your Chameleon tours, surveys, and launchers. Manage the Chameleon integration from the Mixpanel Destinations page. Chameleon also supports an integration to send messaging interactions to Mixpanel - for more details, see [Chameleon's Mixpanel integration](https://help.trychameleon.com/en/articles/1349054-mixpanel-integration-user-guide). @@ -15,46 +14,54 @@ You must be a Mixpanel project admin to enable the Chameleon integration. ## Enable the Integration -Follow these steps to enable the integration with Appcues: - -1. Navigate to **Settings** in the bottom left, then select **Integrations**. +Follow these steps to enable the integration with Chameleon: -2. From the Integrations page, select the Chameleon dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Chameleon, and click **Connect**. -![Chameleon 2 Image](/images/chameleon2.png) + ![Chameleon 2 Image](/images/chameleon2.png) 3. The connection uses one credential to authorize, "API Key". Supply an API key generated from the [Mixpanel-specific integration page within your Chameleon dashboard](https://app.trychameleon.com/settings/integrations/mixpanel) to establish the connection. - 4. The Chameleon integration will show a **Connected** tag in the UI once the connection establishes. ## Matching Users Between Chameleon and Mixpanel Mixpanel only exports identified user profiles to match to Chameleon - users without user profile properties (i.e. anonymous users) will not export. -The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to `chmln.identify("internal_user_id")`. Chameleon will attempt to match users from inbound cohorts based on their Mixpanel distinct_id. +The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to `chmln.identify("internal_user_id")`. Chameleon will attempt to match users from inbound cohorts based on their Mixpanel distinct\_id. ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > Apptimize. Select either one-time sync or dynamic sync. Click **Start Sync**. - - -![Chameleon 3 Image](/images/chameleon3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Chameleon destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> Chameleon. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![Chameleon 3 Image](/images/chameleon3.png) + + + ## Sync Types This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Chameleon a static export of users who currently qualify for the cohort. The cohort data will not be updated in Chameleon after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and Chameleon every two hours. The exported cohort will be updated every day to reflect the most recent list of users in a cohort. ## Ideal vs. Non-Recommended Use Cases @@ -68,10 +75,9 @@ More ideal use cases are instead around tours and surveys where the tour isn't t Once the export completes, you will see a Segment reflecting the set of users from your Mixpanel cohort in the Chameleon Segment tab (via the builder), selecting for "Mixpanel Cohorts" as the Segment filter (e.g. "Users who haven't hit a Value Moment"): -![Chameleon 4 Image](/images/chameleon4.png) + ![Chameleon 4 Image](/images/chameleon4.png) ## Chameleon events in Mixpanel -Chameleon offers the ability to forward tour interaction events to Mixpanel. For more detail, [please refer to Chameleon's integration guide](https://help.trychameleon.com/en/articles/1349054-mixpanel-integration-user-guide). - +Chameleon offers the ability to forward tour interaction events to Mixpanel. For more detail, [please refer to Chameleon's integration guide](https://help.trychameleon.com/en/articles/1349054-mixpanel-integration-user-guide). \ No newline at end of file diff --git a/docs/cohort-sync/integrations/clevertap.mdx b/docs/cohort-sync/integrations/clevertap.mdx index c30153bd..4561aabf 100644 --- a/docs/cohort-sync/integrations/clevertap.mdx +++ b/docs/cohort-sync/integrations/clevertap.mdx @@ -2,65 +2,71 @@ title: "CleverTap" --- - ## Overview -Export Mixpanel cohorts to CleverTap to create custom segments that you can apply in your CleverTap campaigns and journeys. Manage the CleverTap integration from the Mixpanel integrations page. +Export Mixpanel cohorts to CleverTap to create custom segments that you can apply in your CleverTap campaigns and journeys. Manage the CleverTap integration from the Mixpanel Destinations page. CleverTap also supports an integration to send events data to Mixpanel - for more details, [see the CleverTap Mixpanel integration](https://docs.clevertap.com/docs/mixpanel-export). ## Permissions + You must be a Mixpanel project admin to enable the CleverTap integration. ## Enable the Integration -To enable the integration with CleverTap: - -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. +To enable the integration with CleverTap: -2. From the Integrations page, select the CleverTap dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select CleverTap, and click **Connect**. -![CleverTap 2 Image](/images/clevertap2.png) + ![CleverTap 2 Image](/images/clevertap2.png) 3. Specify a **Connector Name** and enter the CleverTap **Project ID**, **Passcode**, and **Data center** details to authorize the connection. - -4. You can optionally select the user properties to export by clicking on the ***Edit Columns*** and selecting the user properties you wish to be included in the export. The default user properties that are exported can be found [here](/docs/cohort-sync#limits). - +4. You can optionally select the user properties to export by clicking on the **_Edit Columns_** and selecting the user properties you wish to be included in the export. The default user properties that are exported can be found [here](/docs/cohort-sync#limits). 5. The CleverTap integration will show a **Connected** tag in the UI once the connection establishes. ## Matching Users between CleverTap and Mixpanel + Mixpanel only exports identified user profiles to match to CleverTap - users without user profile properties (i.e. anonymous users) will not be exported. It is recommended to set a `$CleverTap_user_id` user property with the ID that you use to identify users in Mixpanel. CleverTap will use this property as the first option to match user profiles in CleverTap and include them in the segments. For more information on how CleverTap matches exported cohorts from Mixpanel, refer to [CleverTap's User Identity Management](https://docs.clevertap.com/docs/mixpanel-integration#user-identity-management). -In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$CleverTap_user_id` to the user's distinct_id. This ensures that messaging and experiment data passed from CleverTap to Mixpanel still attributes to the correct user. +In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$CleverTap_user_id` to the user's distinct\_id. This ensures that messaging and experiment data passed from CleverTap to Mixpanel still attributes to the correct user. ## Export a Cohort To export a Cohort to CleverTap: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -Click **Export to > CleverTap**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the CleverTap destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click **Export to \> CleverTap**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + -![CleverTap 3 Image](/images/clevertap3.png) + ![CleverTap 3 Image](/images/clevertap3.png) ## Sync Types -This integration supports two types of exports: one-time export and recurring sync. When you generate a one-time export or recurring sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. +This integration supports two types of exports: one-time export and recurring sync. When you generate a one-time export or recurring sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ## Select the Segment in CleverTap Once the export completes, you will see a segment reflecting the set of users from your Mixpanel cohort in the CleverTap's Segments dashboard. The Type column under the Segments list page for the exported cohort is displayed as `Partner - Mixpanel`: -![CleverTap 4 Image](/images/clevertap4.png) + ![CleverTap 4 Image](/images/clevertap4.png) You can also refer to CleverTap's [Mixpanel Import (Cohort)](https://docs.clevertap.com/docs/mixpanel-integration) documentation. @@ -74,6 +80,7 @@ Events coming from CleverTap are marked with the property `$source`. Mixpanel will exempt certain messaging outreach events from MTU calculations, meaning you're free to send campaigns to dormant users without them counting towards MTU billing (only once a user engages with a message will they then be counted towards that tally). The following CleverTap events are exempt from MTU calculations: + - Notification Sent - Notification Viewed - Notification Clicked @@ -93,4 +100,4 @@ The following CleverTap events are exempt from MTU calculations: - App Uninstalled - Webhook Delivered - State Transitioned -- UTM Visited +- UTM Visited \ No newline at end of file diff --git a/docs/cohort-sync/integrations/facebook-ads.mdx b/docs/cohort-sync/integrations/facebook-ads.mdx index 0ca93ed2..905f695c 100644 --- a/docs/cohort-sync/integrations/facebook-ads.mdx +++ b/docs/cohort-sync/integrations/facebook-ads.mdx @@ -4,7 +4,7 @@ title: "Facebook Ads" ## Overview -Export Mixpanel cohorts to Facebook Ads to use targeted advertisements in Facebook. Manage the Facebook Ads integration from the Mixpanel integrations page. The integration currently supports data from Mixpanel into Facebook Business. +Export Mixpanel cohorts to Facebook Ads to use targeted advertisements in Facebook. Manage the Facebook Ads integration from the Mixpanel Destinations page. The integration currently supports data from Mixpanel into Facebook Business. > You must have a Facebook Business account connected to [Business Manager](https://audience.42matters.com/blog/how-to-connect-your-facebook-ad-account-to-business-manager-to-use-custom-audiences) to use this integration. @@ -16,18 +16,17 @@ You must be a Mixpanel project admin to use the Facebook Ads data integration. Follow these steps to enable the integration with Facebook Ads: -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, click the **Facebook Ads** dropdown. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, then select **Facebook Ads**. -![Facebook 2 Image](/images/facebook2.png) + ![Facebook 2 Image](/images/facebook2.png) 3. Select your Facebook Ad Account ID and your connector name and also choose user property where you're storing device advertising ID (optional) -![Facebook Connector Image](/images/facebook_connector.png) + ![Facebook Connector Image](/images/facebook_connector.png) 4. The Facebook Ads integration page will show a green export icon and details about the integration after it is connected. To disable the connector, select the **Facebook Ads** dropdown and click **Disconnect**. @@ -36,15 +35,23 @@ Follow these steps to enable the integration with Facebook Ads: To export a cohort to Facebook Ads: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three dot icon on the right side of the cohort. - -3. Click **Export to Facebook**. Select either a one-time sync or a dynamic sync. Click **Start Sync**. - - -![Facebook 3 Image](/images/facebook3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Facebook Ads destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three dot icon on the right side of the cohort. + 3. Click **Export to Facebook**. Select either a one-time sync or a dynamic sync. Click **Start Sync**. + + + ![Facebook 3 Image](/images/facebook3.png) + + + ## Sync Types @@ -65,7 +72,7 @@ You must log in to Facebook Business Manager to use the Mixpanel Cohort in Faceb Click on **Audiences**. -![Facebook 4 Image](/images/facebook4.png) + ![Facebook 4 Image](/images/facebook4.png) The Mixpanel Cohort is available in the Audience list. Cohorts are exported to Facebook Ads as `mixpanel__`. @@ -74,7 +81,7 @@ The Mixpanel Cohort is available in the Audience list. Cohorts are exported to F Meta uses _email addresses_ as the primary identifier to match users in your cohort with users in their system. If an email address is not available, Meta may instead attempt to match using other identifiers such as a _phone number_, _first and last name_, or a _device advertising ID_ (depending on your connection setup). -To use this integration, each user profile must include either an _email address_ or a _device advertising ID_. In addition to the email (if present), your system will send the following user profile properties (if available): first name, last name, phone number, advertising ID, and distinct_id. No other user properties will be exported. +To use this integration, each user profile must include either an _email address_ or a _device advertising ID_. In addition to the email (if present), your system will send the following user profile properties (if available): first name, last name, phone number, advertising ID, and distinct\_id. No other user properties will be exported. If Meta is unable to match a cohort member with a user in their system, that member will be excluded from the resulting Meta audience. A lower count in the Meta audience compared to your cohort indicates that some users could not be matched. @@ -82,17 +89,17 @@ If Meta is unable to match a cohort member with a user in their system, that mem Below are some common blocking errors (e.g. Error Message: Invalid OAuth 2.0 Access Token) that may occur when authorizing or using this connection: -#### Login Token Expired. Please disconnect and reconnect from Integrations Page. +#### Login Token Expired. Please disconnect and reconnect from the Destinations page. [Facebook tokens expire after 60 days of inactivity](https://developers.facebook.com/docs/facebook-login/auth-vs-data/). Users will have to log in again to resume the cohort exports. #### (#200) The current user can not update audience XXXXXXXXXXX -Verify the permissions for the user who created the sync, and then disconnect and reconnect from the Integrations page. Disconnecting and Reconnecting will resume your existing exports. +Verify the permissions for the user who created the sync, and then disconnect and reconnect from the Destinations page. Disconnecting and Reconnecting will resume your existing exports. #### Error validating access token: The session has been invalidated because the user changed their password or Facebook has changed the session for security reasons. -Facebook sometimes invalidates the access token if they detect suspicious activity. Disconnect and reconnect the Facebook connection with a new token from the Integrations page to resume syncs. +Facebook sometimes invalidates the access token if they detect suspicious activity. Disconnect and reconnect the Facebook connection with a new token from the Destinations page to resume syncs. #### Error validating access token: The user has not authorized application XXXXXXXXXX. @@ -100,16 +107,16 @@ The user setting up the integration should be using a Facebook business account #### To create or edit a Custom Audience made from a customer list, your admin needs to add this ad account to a business. -Please follow the directions here - https://www.facebook.com/business/help/910137316041095?id=420299598837059 +Please follow the directions here - [https://www.facebook.com/business/help/910137316041095?id=420299598837059](https://www.facebook.com/business/help/910137316041095?id=420299598837059) -#### To create or edit a saved audience with an uploaded customer list, please agree to the Custom Audience terms at https://business.facebook.com/ads/manage/customaudiences/tos/?act=XXXXXXXXXXX. +#### To create or edit a saved audience with an uploaded customer list, please agree to the Custom Audience terms at [https://business.facebook.com/ads/manage/customaudiences/tos/?act=XXXXXXXXXXX](https://business.facebook.com/ads/manage/customaudiences/tos/?act=XXXXXXXXXXX). -We generally force a window to accept the terms and conditions for the users. In rare instances where that doesn't work you can go to the above URL by replacing **XXXXXXXXXXX with your FB account ID**. Accept the terms there and then disconnect + reconnect the integration. +We generally force a window to accept the terms and conditions for the users. In rare instances where that doesn't work you can go to the above URL by replacing **XXXXXXXXXXX with your FB account ID**. Accept the terms there and then disconnect \+ reconnect the integration. #### Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. -Please disable two factor authentication and re-establish the connection from the Integrations page. +Please disable two factor authentication and re-establish the connection from the Destinations page. #### (#2654) Customer List Audiences Are Not Available: Ad accounts owned by businesses new to Facebook Products can create customer file Custom Audiences after several weeks of following our policies. -Please contact Facebook support to get this feature enabled for you. +Please contact Facebook support to get this feature enabled for you. \ No newline at end of file diff --git a/docs/cohort-sync/integrations/google-ads.mdx b/docs/cohort-sync/integrations/google-ads.mdx index e8709b83..9badae23 100644 --- a/docs/cohort-sync/integrations/google-ads.mdx +++ b/docs/cohort-sync/integrations/google-ads.mdx @@ -4,7 +4,7 @@ title: "Google Ads" ## Overview -Export Mixpanel cohorts to Google Ads to use targeted advertisements in Google Search. Manage the Google Ads integration from the Mixpanel integrations page. The integration currently supports data from Mixpanel into a Google Ads account. +Export Mixpanel cohorts to Google Ads to use targeted advertisements in Google Search. Manage the Google Ads integration from the Mixpanel Destinations page. The integration currently supports data from Mixpanel into a Google Ads account. ## Permissions @@ -14,37 +14,45 @@ You must be a Mixpanel project admin to use the Google Ads data integration. Follow these steps to enable the integration with Google Ads: -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the Google Ads dropdown, and select **Sign In with Google**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Google Ads, and click **Sign In with Google**. -![GoogleAds 2 Image](/images/googleads2.png) + ![GoogleAds 2 Image](/images/googleads2.png) 3. Enter your connector name, Google Customer ID and also choose user property where you’re storing device advertising ID (optional) -![GoogleAds Connector Image](/images/googleads_connector.png) + ![GoogleAds Connector Image](/images/googleads_connector.png) 4. The Google Ads integration page shows a green export icon and details about the integration after it is connected. ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - - -![GoogleAds 3 Image](/images/googleads3.png) - - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click **Export to Google Ads**. Select either one-time sync or dynamic sync. Click **Start Sync**. - - -![GoogleAds 4 Image](/images/googleads4.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Google Ads destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + + + ![GoogleAds 3 Image](/images/googleads3.png) + + + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click **Export to Google Ads**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![GoogleAds 4 Image](/images/googleads4.png) + + + ## Sync Types @@ -65,20 +73,20 @@ You must log in to Google Business Manager to use the Mixpanel Cohort in Google Click on **Tools & Settings** and launch Audience Manager. -![GoogleAds 5 Image](/images/googleads5.png) + ![GoogleAds 5 Image](/images/googleads5.png) The Mixpanel Cohort is available under Audience Manager. Cohorts are exported to Google Ads as `mixpanel**`. -![GoogleAds 6 Image](/images/googleads6.png) + ![GoogleAds 6 Image](/images/googleads6.png) ## Data Requirements Google Ads matches users from your Mixpanel cohort to users in its system primarily using _email addresses_. If an email address is not available, Google Ads can instead attempt to match users using other identifiers — such as a _phone number_, _first and last name_, or a _device advertising ID_, depending on how you configure the connection. -To use this integration, your Mixpanel user profiles must include either an _email address_ or a _device advertising ID_. Along with those identifiers, Mixpanel also sends the following user properties (if available): first name, last name, phone number, advertising ID, and distinct_id. No other user properties are exported. +To use this integration, your Mixpanel user profiles must include either an _email address_ or a _device advertising ID_. Along with those identifiers, Mixpanel also sends the following user properties (if available): first name, last name, phone number, advertising ID, and distinct\_id. No other user properties are exported. If Google Ads cannot match a cohort member with a user in its system, that member will be excluded from the Google Ads audience. A lower number of users in Google Audiences compared to your Mixpanel cohort means some users could not be matched. @@ -102,10 +110,10 @@ Please make sure the user setting the integrations has standard or admin access Please make sure the user setting the integrations has standard or admin access in the Google Ads account. -**User doesn't have permission to access customer. Note: If you're accessing a client customer, the manager's customer id must be set in the 'login-customer-id' header. See https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid** +**User doesn't have permission to access customer. Note: If you're accessing a client customer, the manager's customer id must be set in the 'login-customer-id' header. See [https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid](https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid)** Please make sure the user setting the integrations has standard or admin access in the Google Ads account. **User in the cookie is not a valid Ads user.** -Please make sure the user setting the integrations has standard or admin access in the Google Ads account. +Please make sure the user setting the integrations has standard or admin access in the Google Ads account. \ No newline at end of file diff --git a/docs/cohort-sync/integrations/insider.mdx b/docs/cohort-sync/integrations/insider.mdx index 83e407e2..6ae2436c 100644 --- a/docs/cohort-sync/integrations/insider.mdx +++ b/docs/cohort-sync/integrations/insider.mdx @@ -4,7 +4,7 @@ title: "Insider" ## Overview -Export Mixpanel cohorts to Insider to create custom segments that you can apply in your Insider campaigns. Manage the Insider integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Insider to create custom segments that you can apply in your Insider campaigns. Manage the Insider integration from the Mixpanel Destinations page. ## Permissions @@ -12,19 +12,17 @@ You must be a Mixpanel project admin to enable the Insider integration. ## Enable the Integration -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the Insider dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Insider, and click **Connect**. - If you set a User ID Property, it should be a Mixpanel user property that matches the email or phone number set in Insider. + If you set a User ID Property, it should be a Mixpanel user property that matches the email or phone number set in Insider. -![insider 2 Image](/images/insider2.png) + ![insider 2 Image](/images/insider2.png) - 3. The Insider integration will show a **Connected** tag in the UI once the connection succeeds. ## Matching Users between Insider and Mixpanel @@ -37,24 +35,34 @@ Note that exports are used solely for matching user identities between products ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > Insider. Select either one-time sync or dynamic sync. Click **Start Sync**. - - -![insider 3 Image](/images/insider3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Insider destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> Insider. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![insider 3 Image](/images/insider3.png) + + + ## Sync Types This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Insider a static export of users who currently qualify for the cohort. The cohort data will not be updated in Insider after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and Insider every 15 minutes. The exported cohort will be updated every 15 minutes to reflect the most recent list of users in a cohort. ## Select the Custom Segment in Insider @@ -62,5 +70,5 @@ In dynamic sync, Mixpanel initiates sync between a cohort and Insider every 15 m Once the export completes, you will see a custom segment reflecting the set of users from your Mixpanel cohort. (e.g. "7days-cart-abandoners") -![insider 4 Image](/images/insider4.png) - + ![insider 4 Image](/images/insider4.png) + \ No newline at end of file diff --git a/docs/cohort-sync/integrations/iterable.mdx b/docs/cohort-sync/integrations/iterable.mdx index d3489275..f44d9160 100644 --- a/docs/cohort-sync/integrations/iterable.mdx +++ b/docs/cohort-sync/integrations/iterable.mdx @@ -2,10 +2,9 @@ title: "Iterable" --- - ## Overview -Export Mixpanel cohorts to Iterable to create user lists that you can target in your Iterable campaigns. Manage the Iterable integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Iterable to create user lists that you can target in your Iterable campaigns. Manage the Iterable integration from the Mixpanel Destinations page. ## Permissions @@ -13,36 +12,44 @@ You must be a Mixpanel project admin to use the Iterable data integration. ## Enable the Integration -1. Navigate to **Settings** in the bottom left, then select **Integrations**. - -2. From the Integrations page, select the Insider dropdown, and select **Connect**. - +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Iterable, and click **Connect**. 3. The Iterable integration page will show a green export icon and details about the integration after it is connected. -If you select the US or EU Iterable data center, data will be sent to the corresponding Iterable project. Note: Every Iterable API key is associated with a specific Iterable project, which means that it's also associated with a specific data center. Further reading: https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#api-keys-projects-and-data-centers +If you select the US or EU Iterable data center, data will be sent to the corresponding Iterable project. Note: Every Iterable API key is associated with a specific Iterable project, which means that it's also associated with a specific data center. Further reading: [https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#api-keys-projects-and-data-centers](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys#api-keys-projects-and-data-centers) To disable the connector, select the Iterable dropdown and click **Disconnect**. ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > Iterable. Select either one-time sync or dynamic sync. Click **Start Sync**. - - -![iterable 3 Image](/images/iterable3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Iterable destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> Iterable. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![iterable 3 Image](/images/iterable3.png) + + + ## Sync Types This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Iterable a static export of users who currently qualify for the cohort. The cohort data will not be updated in Iterable after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and Iterable every fifteen minutes. The exported cohort will be updated every fifteen minutes to reflect the most recent list of users in a cohort. ## Select the Cohort in Iterable @@ -52,7 +59,7 @@ You must log in to Iterable to use the Mixpanel Cohorts to send campaigns. The Mixpanel Cohort is available in the Audience list. Mixpanel exports cohort data as `mixpanel__`. -![iterable 4 Image](/images/Iterable4.png) + ![iterable 4 Image](/images/Iterable4.png) ## Matching Users between Mixpanel and Iterable @@ -62,7 +69,7 @@ The Mixpanel Cohort is available in the Audience list. Mixpanel exports cohort d The best way to match users from Mixpanel to Iterable is to grab the value displayed as `userId` in Iterable and store it as a profile property for the user in Mixpanel under the name `$iterable_user_id`. This also prevents Iterable from overwriting the Iterable User ID with the Mixpanel Distinct ID upon cohort sync from Mixpanel. For context, the value you should store as `$iterable_user_id` in the Mixpanel profile would look like this in Iterable: -![Iterable's user ID](/images/iterable_user_id.png) + ![Iterable's user ID](/images/iterable_user_id.png) Iterable uses an email address to match users from the cohort with users from their system. The integration will fail if an email address is not sent. In order to use this integration, you must set email as a user profile property. @@ -93,5 +100,4 @@ The following events are exempt from MTU calculations: - smsReceived - smsSend - smsSendSkip -- webPushSendSkip - +- webPushSendSkip \ No newline at end of file diff --git a/docs/cohort-sync/integrations/kameleoon.mdx b/docs/cohort-sync/integrations/kameleoon.mdx index 944c4b2c..b0fbf288 100644 --- a/docs/cohort-sync/integrations/kameleoon.mdx +++ b/docs/cohort-sync/integrations/kameleoon.mdx @@ -2,10 +2,9 @@ title: "Kameleoon" --- - ## Overview -Export Mixpanel cohorts to Kameleoon to create custom segments that you can apply in your Kameleoon experiments. Manage the Kameleoon integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Kameleoon to create custom segments that you can apply in your Kameleoon experiments. Manage the Kameleoon integration from the Mixpanel Destinations page. Kameleoon also supports an integration to send experiment data to Mixpanel - for more details, see [the Kameleoon Mixpanel integration](https://help.kameleoon.com/en/setting-up-mixpanel/). @@ -15,42 +14,50 @@ You must be a Mixpanel project admin to enable the Kameleoon integration. ## Enable the Integration -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the Kameleoon dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Kameleoon, and click **Connect**. -![Kameleoon 2 Image](/images/kameleoon2.png) + ![Kameleoon 2 Image](/images/kameleoon2.png) 3. The connection uses one credential to authorize, "API Key". Supply an **API token** generated from your Kameleoon settings page to establish the connection. - 4. The Kameleoon integration will show a **Connected** tag in the UI once the connection establishes. ## Matching Users Between Kameleoon and Mixpanel Mixpanel only exports identified user profiles to match to Kameleoon - users without user profile properties (i.e. anonymous users) will not export. -The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to Kameleoon when identifying a "visitor". Kameleoon will attempt to match users from inbound cohorts based on their Mixpanel distinct_id. +The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to Kameleoon when identifying a "visitor". Kameleoon will attempt to match users from inbound cohorts based on their Mixpanel distinct\_id. -Additionally, if you're using Mixpanel's identity merge feature, you may want to provide a consistent identity value to deliver to Kameleoon (as Mixpanel's distinct_id for a given user may change over time as the user's Canonical ID shifts). To provide a consistent user identifier to Kameleoon, **you may specify a user property**, `$kameleoon_mapping_id`, whose value is a string representing the user's consistent identifier (for example, an internal user ID). Mixpanel will also deliver this property to Kameleoon for user matching. +Additionally, if you're using Mixpanel's identity merge feature, you may want to provide a consistent identity value to deliver to Kameleoon (as Mixpanel's distinct\_id for a given user may change over time as the user's Canonical ID shifts). To provide a consistent user identifier to Kameleoon, **you may specify a user property**, `$kameleoon_mapping_id`, whose value is a string representing the user's consistent identifier (for example, an internal user ID). Mixpanel will also deliver this property to Kameleoon for user matching. ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > Insider. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Kameleoon destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> Kameleoon. Select either one-time sync or dynamic sync. Click **Start Sync**. + + ## Sync Types This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Kameleoon a static export of users who currently qualify for the cohort. The cohort data will not be updated in Kameleoon after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and Kameleoon every two hours. The exported cohort will be updated every day to reflect the most recent list of users in a cohort. ## Select the Segment in Kameleoon @@ -58,9 +65,9 @@ In dynamic sync, Mixpanel initiates sync between a cohort and Kameleoon every tw Once the export completes, you will see a Segment reflecting the set of users from your Mixpanel cohort in Kameleoon's Segment editor, as custom data (e.g. "Song Sharers"): -![Kameleoon 3 Image](/images/kameleoon3.png) + ![Kameleoon 3 Image](/images/kameleoon3.png) ## Kameleoon Data into Mixpanel -Kameleoon offers the ability to forward experiment data to Mixpanel. For more detail, please refer to [the Kameleoon integration guide](https://help.kameleoon.com/en/setting-up-mixpanel/). +Kameleoon offers the ability to forward experiment data to Mixpanel. For more detail, please refer to [the Kameleoon integration guide](https://help.kameleoon.com/en/setting-up-mixpanel/). \ No newline at end of file diff --git a/docs/cohort-sync/integrations/leanplum.mdx b/docs/cohort-sync/integrations/leanplum.mdx index a2aec6b2..bb88771e 100644 --- a/docs/cohort-sync/integrations/leanplum.mdx +++ b/docs/cohort-sync/integrations/leanplum.mdx @@ -2,10 +2,9 @@ title: "Leanplum" --- - ## Overview -Export Mixpanel cohorts to Leanplum to create custom audiences that you can apply in your Leanplum campaigns. Manage the Leanplum integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Leanplum to create custom audiences that you can apply in your Leanplum campaigns. Manage the Leanplum integration from the Mixpanel Destinations page. Leanplum also supports an integration to send messaging interactions to Mixpanel - for more details, see [Leanplum's Mixpanel integration](https://docs.leanplum.com/docs/mixpanel-feed). @@ -15,12 +14,11 @@ You must be a Mixpanel project admin to enable the Leanplum integration. ## Enable the Integration -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the Leanplum dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Leanplum, and click **Connect**. -![Leanplum 2 Image](/images/leanplum2.png) + ![Leanplum 2 Image](/images/leanplum2.png) 3. The connection uses a Basic Authorization Username/Password system. You will need to provide two credentials to authorize the connection: @@ -38,34 +36,44 @@ You can find these values in your Leanplum settings page, and under the Mixpanel Mixpanel only exports identified user profiles to match to Leanplum - users without user profile properties (i.e. anonymous users) will not export. -If you use a different system of user identifiers for Mixpanel's distinct_id as compared to Leanplum's user ID, the user's Mixpanel profile must contain a user property, `$leanplum_user_id`, whose value is a string representing that person's user ID in Leanplum. Use this joining key if your user identifiers in Mixpanel are different from the identifiers used in Leanplum (for example, if you identify Mixpanel users on internal user ID, but identify Leanplum users on device ID). +If you use a different system of user identifiers for Mixpanel's distinct\_id as compared to Leanplum's user ID, the user's Mixpanel profile must contain a user property, `$leanplum_user_id`, whose value is a string representing that person's user ID in Leanplum. Use this joining key if your user identifiers in Mixpanel are different from the identifiers used in Leanplum (for example, if you identify Mixpanel users on internal user ID, but identify Leanplum users on device ID). -In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$leanplum_user_id` to the user's distinct_id. This ensures that messaging data passed from Leanplum to Mixpanel still attributes to the correct user. +In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$leanplum_user_id` to the user's distinct\_id. This ensures that messaging data passed from Leanplum to Mixpanel still attributes to the correct user. -If you use the same system of user identifiers in both tools, meaning a user has the same ID string in both products, you do **not** have to declare `$leanplum_user_id`. The users' Mixpanel distinct_id will still be sent in the cohort export, and Leanplum will attempt to match users on this value instead. +If you use the same system of user identifiers in both tools, meaning a user has the same ID string in both products, you do **not** have to declare `$leanplum_user_id`. The users' Mixpanel distinct\_id will still be sent in the cohort export, and Leanplum will attempt to match users on this value instead. Note that exports are used solely for matching user identities between products - the integration will not send the full set of a user's profile properties to Leanplum. ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > Insider. Select either one-time sync or dynamic sync. Click Start Sync. - - -![Leanplum 3 Image](/images/leanplum3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Leanplum destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> Leanplum. Select either one-time sync or dynamic sync. Click Start Sync. + + + ![Leanplum 3 Image](/images/leanplum3.png) + + + ## Sync Types This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. In case of dynamic sync, we compute a diff of users added and removed from the cohort's current state compared to the cohort state present on Leanplum and send the diff over to Leanplum to apply these changes. ### One-Time Export + In a one-time export, Mixpanel sends Leanplum a static export of users who currently qualify for the cohort. The cohort data will not be updated in Leanplum after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel exports the cohort to Leanplum every 15 minutes. The exported cohort will be updated every 15 minutes to reflect the most recent list of users in a cohort. ## Select the Audience in Leanplum @@ -73,7 +81,7 @@ In dynamic sync, Mixpanel exports the cohort to Leanplum every 15 minutes. The e Once the export completes, you will see an Audience reflecting the set of users from your Mixpanel cohort. (e.g. "Recent Signups who haven't hit a Value Moment") -![Leanplum 4 Image](/images/leanplum4.png) + ![Leanplum 4 Image](/images/leanplum4.png) ## Leanplum events into Mixpanel & MTU exemptions @@ -94,4 +102,4 @@ The following events are exempt from MTU calculations: - (Leanplum) Email Bounce - (Leanplum) Email Marked as spam - (Leanplum) Email Unsubscribed -- (Leanplum) A/B test +- (Leanplum) A/B test \ No newline at end of file diff --git a/docs/cohort-sync/integrations/mailchimp.mdx b/docs/cohort-sync/integrations/mailchimp.mdx index 1677899c..21a3b472 100644 --- a/docs/cohort-sync/integrations/mailchimp.mdx +++ b/docs/cohort-sync/integrations/mailchimp.mdx @@ -2,10 +2,9 @@ title: "Mailchimp" --- - ## Overview -Export Mixpanel cohorts to Mailchimp to create custom audiences that you can apply in your Mailchimp campaigns. Manage the Mailchimp integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Mailchimp to create custom audiences that you can apply in your Mailchimp campaigns. Manage the Mailchimp integration from the Mixpanel Destinations page. ## Permissions @@ -17,12 +16,11 @@ The Mailchimp integration requires initial configuration through your Mailchimp Follow these steps to enable the integration with Mailchimp: -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the Mailchimp dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Mailchimp, and click **Connect**. -![mailchimp 2 Image](/images/mailchimp2.png) + ![mailchimp 2 Image](/images/mailchimp2.png) You will need to provide an API key (referred to as an Authorization token in Mailchimp) to authorize the connection. Mailchimp will provide this token during the integration initialization flow. @@ -39,24 +37,34 @@ In order to match an exported Mixpanel user to Mailchimp, the user's Mixpanel pr ## Export a Cohort -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click **Export to > Mailchimp**. Select either one-time sync or dynamic sync. Click **Start Sync**. - - -![mailchimp 3 Image](/images/mailchimp3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Mailchimp destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click **Export to \> Mailchimp**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![mailchimp 3 Image](/images/mailchimp3.png) + + + ## Sync Types This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Mailchimp a static export of users who currently qualify for the cohort. The cohort data will not be updated in Mailchimp after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and Mailchimp every 2 hours. The exported cohort will be updated every two hours to reflect the most recent list of users in a cohort. ## Observe the Audience in Mailchimp @@ -64,7 +72,7 @@ In dynamic sync, Mixpanel initiates sync between a cohort and Mailchimp every 2 Once the export completes, you will see updates in your Mailchimp dashboard reflecting your synced audience: -![mailchimp 4 Image](/images/mailchimp4.png) + ![mailchimp 4 Image](/images/mailchimp4.png) ## MTU exemptions @@ -79,7 +87,4 @@ The following events are exempt from MTU calculations: - Mailchimp - Clicked Campaign Url - Mailchimp - Sent To - Mailchimp - Unsubscribed -- Mailchimp - Bounced - - - +- Mailchimp - Bounced \ No newline at end of file diff --git a/docs/cohort-sync/integrations/marketo.mdx b/docs/cohort-sync/integrations/marketo.mdx index f81df4e2..c821bc52 100644 --- a/docs/cohort-sync/integrations/marketo.mdx +++ b/docs/cohort-sync/integrations/marketo.mdx @@ -2,7 +2,6 @@ title: "Marketo" --- - ## Overview The Marketo integration with Mixpanel is a turn-key integration that allows users to export Mixpanel cohorts into Marketo. The integration enables Marketo email campaigns to target users based on Mixpanel cohort data. The cohort export can happen once, or can be configured to dynamically update a Marketo Custom Field every two hours. @@ -15,55 +14,68 @@ You must be a Mixpanel project admin to use the Marketo data integration. In order to setup your Mixpanel and Marketo Integration, you must be an Admin in both Marketo and your Mixpanel project. To set up the integration: -1. Input your[Marketo credentials](http://developers.marketo.com/rest-api/authentication/) (Client ID, Client Secret, Rest URL) in the Mixpanel integration setup flow. Remove "identity" from the url so its rest endpoint when setting up the integration looks like: https://051-pvi-353.mktorest.com/ - +1. Input your[Marketo credentials](http://developers.marketo.com/rest-api/authentication/) (Client ID, Client Secret, Rest URL) in the Mixpanel integration setup flow. Remove "identity" from the url so its rest endpoint when setting up the integration looks like: [https://051-pvi-353.mktorest.com/](https://051-pvi-353.mktorest.com/) 2. Create a Mixpanel Custom Field in Marketo. **This Custom Field should be set as a boolean type**. Read the [Marketo Documentation](https://docs.marketo.com/display/public/DOCS/Create+a+Custom+Field+in+Marketo) for additional information on how to set up a Custom Field. - 3. The new Custom Field will update to 'True', allowing you to target users based on the Mixpanel cohort criteria. - ## Sending a Mixpanel Cohort to Marketo To send a Mixpanel Cohort to Marketo: 1. Create a [Custom Field in Marketo](https://docs.marketo.com/display/public/DOCS/Create+a+Custom+Field+in+Marketo) for each cohort that you plan to export. +2. Export the cohort from Mixpanel: -2. Navigate to **Lexicon**, then select **Cohorts** to view all cohorts. - - -![Marketo 1 Image](/images/marketo1.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Marketo destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync. + + + 1. Navigate to **Lexicon**, then select **Cohorts** to view all cohorts. -3. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + + ![Marketo 1 Image](/images/marketo1.png) + -4. Copy and paste the field name associated with the cohort you want to export into Marketo. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + + -5. After exporting your cohort to Marketo, the custom field name for all matched users will be set to True. +3. Copy and paste the field name associated with the cohort you want to export into Marketo. +4. After exporting your cohort to Marketo, the custom field name for all matched users will be set to True. ## Sync Types This integration supports two types of exports: one-time export and dynamic sync. -### One-Time Exports +### One-Time Exports + The Custom Field will automatically be updated to 'True', allowing you to target users based on this criteria. ### Dynamic Syncs + The Custom Field will be updated every two hours to reflect the status of the Mixpanel cohort. The Custom Field will be set to 'True' or 'False' to reflect the movement of any users in to or out of a Mixpanel cohort. ## FAQ ### Exporting the Same Cohort to Marketo + It is possible to export the same cohort to Marketo more than once, however each export will require a new custom field within Marketo. Mixpanel disallows exporting to the same custom field so that the custom field you have created in Marketo is up-to-date with only the latest export. ### Why is the cohort user count larger in Mixpanel than in Marketo? + In order to export a user to Marketo using Cohorts, the user must have the special user profile property \$email set on their user profile. If this property is not set on a user’s profile, they will not be exported to Marketo. ### How does Mixpanel handle users that exist within Mixpanel, but not in Marketo? + If the user within Mixpanel has the \$email user profile property, a new lead will be created in Marketo with the \$email user profile property value and the designated custom field will be set to True. ### Is there a limitation to the number of profiles that can be exported to Marketo? + The maximum cohort size exportable is 30 million profiles. ### Does Mixpanel export other profile properties to Marketo besides the user's email address? -No. At this time, Mixpanel will only export the \$email profile property. +No. At this time, Mixpanel will only export the \$email profile property. \ No newline at end of file diff --git a/docs/cohort-sync/integrations/moengage.mdx b/docs/cohort-sync/integrations/moengage.mdx index 1cbac01f..88e53d84 100644 --- a/docs/cohort-sync/integrations/moengage.mdx +++ b/docs/cohort-sync/integrations/moengage.mdx @@ -1,11 +1,11 @@ --- -sidebarTitle: "MoEngage" title: "Moengage" +sidebarTitle: "MoEngage" --- ## Overview -Export Mixpanel cohorts to MoEngage to create custom segments that you can apply in your MoEngage campaigns. Manage the MoEngage integration from the Mixpanel integrations page. +Export Mixpanel cohorts to MoEngage to create custom segments that you can apply in your MoEngage campaigns. Manage the MoEngage integration from the Mixpanel Destinations page. # Permissions @@ -13,16 +13,15 @@ You must be a Mixpanel project admin to enable the MoEngage integration. ## Enable the Integration -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the MoEngage dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select MoEngage, and click **Connect**. - If you set a User ID Property, it should be a Mixpanel user property that matches the MoEngage External ID. If you do not select one, Mixpanel will default to using the `$moengage_user_id` property to match users between MoEngage and Mixpanel. See more about [matching users between MoEngage and Mixpanel](/docs/cohort-sync/integrations/moengage#matching-users-between-moengage-and-mixpanel). + If you set a User ID Property, it should be a Mixpanel user property that matches the MoEngage External ID. If you do not select one, Mixpanel will default to using the `$moengage_user_id` property to match users between MoEngage and Mixpanel. See more about [matching users between MoEngage and Mixpanel](/docs/cohort-sync/integrations/moengage#matching-users-between-moengage-and-mixpanel). -![Moengage 2 Image](/images/moengage2.png) + ![Moengage 2 Image](/images/moengage2.png) 3. The connection uses a Basic Authorization Username/Password system. You will need to provide two credentials to authorize the connection: @@ -37,7 +36,7 @@ You will additionally provide one credential to authorize the cohort exports: You can find these values in your MoEngage settings page - note that MoEngage App ID is used in both the Username and MOE-APPKEY fields. -![Moengage 3 Image](/images/moengage3.png) + ![Moengage 3 Image](/images/moengage3.png) 4. The MoEngage integration will show a **Connected** tag in the UI once the connection succeeds. @@ -45,14 +44,14 @@ You can find these values in your MoEngage settings page - note that MoEngage Ap ## Matching Users between MoEngage and Mixpanel - **Warning:** Projects using the [Simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the `$user_id` in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the below section are primarily applicable to projects on the original ID merge system. + **Warning:** Projects using the [Simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the `$user_id` in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the below section are primarily applicable to projects on the original ID merge system. Mixpanel only exports identified user profiles to match to MoEngage - users without user profile properties (i.e. anonymous users) will not export. -If the values you provide for users' distinct_id differ from the values used for MoEngage's Unique ID, the user's Mixpanel profile must contain a user property, `$moengage_user_id`, whose value is a string representing that user's Unique ID in MoEngage. Exports will include this joining key to match the corresponding Unique ID in MoEngage. +If the values you provide for users' distinct\_id differ from the values used for MoEngage's Unique ID, the user's Mixpanel profile must contain a user property, `$moengage_user_id`, whose value is a string representing that user's Unique ID in MoEngage. Exports will include this joining key to match the corresponding Unique ID in MoEngage. -In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$moengage_user_id` to the user's distinct_id. This ensures that messaging data passed from MoEngage to Mixpanel still attributes to the correct user. +In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$moengage_user_id` to the user's distinct\_id. This ensures that messaging data passed from MoEngage to Mixpanel still attributes to the correct user. Note that exports are used solely for matching user identities between products - the integration will not send the full set of a user's profile properties to MoEngage, nor will it generate new user profiles in MoEngage. @@ -60,11 +59,19 @@ Note that exports are used solely for matching user identities between products To export a cohort to MoEngage: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort and click **Export to MoEngage**. - -3. Click **Start Sync**. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the MoEngage destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync. Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort and click **Export to MoEngage**. + 3. Click **Start Sync**. + + ## Sync Types @@ -83,7 +90,7 @@ In dynamic sync, Mixpanel initiates sync between a cohort and MoEngage every 15 Once the export completes, you will see a custom segment reflecting the set of users from your Mixpanel cohort (e.g. "Power Users"): -![Moengage 6 Image](/images/moengage6.png) + ![Moengage 6 Image](/images/moengage6.png) ## MoEngage Events into Mixpanel & MTU exemptions @@ -107,9 +114,9 @@ The following MoEngage events are exempt from MTU calculations: - Email Soft Bounced - Notification Received Android - Notification Sent iOS -- NOTIFICATION_RECEIVED_IOS_MOE +- NOTIFICATION\_RECEIVED\_IOS\_MOE - Notification Received Web - SMS Sent - SMS Delivered - User Entered Flow -- User Exited Flow +- User Exited Flow \ No newline at end of file diff --git a/docs/cohort-sync/integrations/mparticle.mdx b/docs/cohort-sync/integrations/mparticle.mdx index 3f31cbf4..2f0fa3b6 100644 --- a/docs/cohort-sync/integrations/mparticle.mdx +++ b/docs/cohort-sync/integrations/mparticle.mdx @@ -18,29 +18,28 @@ This connection requires setup on both mParticle and Mixpanel. ### mParticle Setup 1. Log into your mParticle workspace. -2. Navigate to **Data Platform > Setup > Inputs**. +2. Navigate to **Data Platform \> Setup \> Inputs**. 3. Select the **Feed** input type and search for **Mixpanel Cohorts**. - ![mParticle 1 Image](/images/mparticle1.png) + ![mParticle 1 Image](/images/mparticle1.png) - Set Input Protection Level to Only Update Profiles to ensure only existing profiles can be updated and no new profiles will be created from cohort syncs. 4. Save and copy your **Webhook URL**. - ![mParticle 2 Image](/images/mparticle2.png) + ![mParticle 2 Image](/images/mparticle2.png) ### Mixpanel Setup -Mixpanel uses your mParticle API token to send data to the following endpoint: -`https://inbound.mparticle.com/v1/pdf/mixpanelcohorts/{{customer_api_token}}` +Mixpanel uses your mParticle API token to send data to the following endpoint: `https://inbound.mparticle.com/v1/pdf/mixpanelcohorts/{{customer_api_token}}` -1. Navigate to **Settings** in the bottom left, then select **Integrations**. -2. Find **mParticle** in the list, click **Connect**, and paste your **mParticle Webhook URL** into the box. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select **mParticle**, click **Connect**, and paste your **mParticle Webhook URL** into the box. 3. Click **Continue** to establish the connection. - ![mParticle 5 Image](/images/mparticle5.png) + ![mParticle 5 Image](/images/mparticle5.png) --- @@ -49,15 +48,30 @@ Mixpanel uses your mParticle API token to send data to the following endpoint: To export a Mixpanel cohort to mParticle: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. -2. Find the cohort you wish to export, click the **three-dot overflow menu (...)**, and select **Export to... > mParticle**. -3. Select the sync type: - - **One-Time Export:** A static snapshot of the cohort is sent immediately. - - **Recurring (Dynamic) Sync:** Mixpanel will automatically update the audience in mParticle as users enter or exit the criteria. -4. Click **Start Sync**. - - ![mParticle 6 Image](/images/mparticle6.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the mParticle destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you wish to export. + 5. Select the sync type: + - **One-Time Export:** A static snapshot of the cohort is sent immediately. + - **Recurring (Dynamic) Sync:** Mixpanel will automatically update the audience in mParticle as users enter or exit the criteria. + 6. Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Find the cohort you wish to export, click the **three-dot overflow menu (...)**, and select **Export to... \> mParticle**. + 3. Select the sync type: + - **One-Time Export:** A static snapshot of the cohort is sent immediately. + - **Recurring (Dynamic) Sync:** Mixpanel will automatically update the audience in mParticle as users enter or exit the criteria. + 4. Click **Start Sync**. + + + ![mParticle 6 Image](/images/mparticle6.png) + + + --- @@ -73,13 +87,13 @@ In a dynamic sync, Mixpanel initiates a sync every 15 minutes. Mixpanel sends "d --- -## Setting \$mparticle_user_id in Mixpanel +## Setting \$mparticle\_user\_id in Mixpanel If you find that Mixpanel Cohorts are not properly matching again mParticle Cohorts, this is most likely because the primary identifier in mParticle is not set in Mixpanel’s user profiles. This is easy to connect using one of the two below methods -### Set \$mparticle_user_id as a User Attribute via SDK (Recommended for Developers) +### Set \$mparticle\_user\_id as a User Attribute via SDK (Recommended for Developers) -To ensure \$mparticle_user_id appears as a specific property on the user profile, you can manually set it as a user attribute in your app's code. Since mParticle forwards all user attributes to Mixpanel (if "Include User Attributes" is enabled), this is the most reliable method. +To ensure \$mparticle\_user\_id appears as a specific property on the user profile, you can manually set it as a user attribute in your app's code. Since mParticle forwards all user attributes to Mixpanel (if "Include User Attributes" is enabled), this is the most reliable method. Web SDK Example: @@ -103,11 +117,11 @@ if let currentUser = MParticle.sharedInstance().identity.currentUser { If you cannot change your app's code, you can use mParticle Rules to automatically map the MPID to a user attribute before it is sent to Mixpanel. -Go to Data Plan > Rules in mParticle. +Go to Data Plan \> Rules in mParticle. Create a new Rule for the Mixpanel Output. -Use the rule to copy the mpid from the batch level into the user_attributes object as \$mparticle_user_id. +Use the rule to copy the mpid from the batch level into the user\_attributes object as \$mparticle\_user\_id. Logic: `batch.user_attributes['$mparticle_user_id'] = batch.mpid;` @@ -117,9 +131,7 @@ Once the rule is active, every event sent to Mixpanel will include this attribut For these connections methods to work as intended, ensure these toggles are active in your Mixpanel Connection Settings in mParticle: -Use Mixpanel People: Must be True (to enable user profiles). -Include User Attributes: Must be True (to ensure the custom \$mparticle_user_id attribute is forwarded). -Create Profile Only If Logged In: Set to True (typically we will only want profile + cohorts based on known/authenticated users) +Use Mixpanel People: Must be True (to enable user profiles). Include User Attributes: Must be True (to ensure the custom \$mparticle\_user\_id attribute is forwarded). Create Profile Only If Logged In: Set to True (typically we will only want profile \+ cohorts based on known/authenticated users) --- @@ -129,8 +141,8 @@ Create Profile Only If Logged In: Set to True (typically we will only want profi To ensure users are correctly matched in mParticle, Mixpanel maps identifiers in the following order of priority: -1. `$mparticle_user_id`: If this property exists on the Mixpanel user profile, it will be used as the primary identifier. -2. `$distinct_id`: If `$mparticle_user_id` is not present, Mixpanel falls back to the standard `$distinct_id`. +1. `$mparticle_user_id`: If this property exists on the Mixpanel user profile, it will be used as the primary identifier. +2. `$distinct_id`: If `$mparticle_user_id` is not present, Mixpanel falls back to the standard `$distinct_id`. ### Data Format @@ -164,18 +176,18 @@ Once the export begins, you can verify the data flow in mParticle: ### Generic validation -1. Navigate to **Data Platform > Trends** (or Live Stream if you are using dev data). +1. Navigate to **Data Platform \> Trends** (or Live Stream if you are using dev data). 2. Select your Mixpanel input feed in the inputs dropdown to see of user profile updates received from the mixpanel cohort sync. - ![mParticle 3 Image](/images/mparticle3.png) + ![mParticle 3 Image](/images/mparticle3.png) ### User specific validation (requires org setup and user permission for user profile lookup) 1. In your Mixpanel cohort grab the Mparticle User id -2. Go to mParticle > Customer 360 > User Profiles and search the user +2. Go to mParticle \> Customer 360 \> User Profiles and search the user - ![mParticle 4 Image](/images/mparticle4.png) + ![mParticle 4 Image](/images/mparticle4.png) 3. Check that the user has a user attribute with the name of your cohort. @@ -195,4 +207,4 @@ To check for eligible users in Mixpanel: ### Export is Paused -If your sync is marked as **Paused** in the Mixpanel Integrations tab, hover over the status to see the error. This is usually caused by an invalid webhook url or a connection issue with the mParticle endpoint. You can typically resolve this by disconnecting and reconnecting the integration with a fresh API token. +If your sync is marked as **Paused** in the Mixpanel Destinations page, hover over the status to see the error. This is usually caused by an invalid webhook url or a connection issue with the mParticle endpoint. You can typically resolve this by disconnecting and reconnecting the integration with a fresh API token. \ No newline at end of file diff --git a/docs/cohort-sync/integrations/onesignal.mdx b/docs/cohort-sync/integrations/onesignal.mdx index 8c416cc2..9e7a0f3c 100644 --- a/docs/cohort-sync/integrations/onesignal.mdx +++ b/docs/cohort-sync/integrations/onesignal.mdx @@ -4,7 +4,7 @@ title: "OneSignal" ## Overview -Export Mixpanel cohorts to OneSignal to create custom segments that you can apply in your OneSignal campaigns. Manage the OneSignal integration from the Mixpanel integrations page. +Export Mixpanel cohorts to OneSignal to create custom segments that you can apply in your OneSignal campaigns. Manage the OneSignal integration from the Mixpanel Destinations page. OneSignal also supports an integration to send messaging interactions to Mixpanel - for more details, see [OneSignal's Mixpanel integration](https://documentation.onesignal.com/docs/mixpanel). @@ -18,24 +18,23 @@ Additionally, you must have a paid OneSignal plan to use the integration. If you Follow these steps to enable the integration with OneSignal: -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the OneSignal dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select OneSignal, and click **Connect**. - If you set a User ID Property, it should be a Mixpanel user property that matches the OneSignal External ID. If you do not select one, Mixpanel will default to using the `$onesignal_user_id` property to match users between OneSignal and Mixpanel. See more about [matching users between OneSignal and Mixpanel](/docs/cohort-sync/integrations/onesignal#matching-users-between-onesignal-and-mixpanel). + If you set a User ID Property, it should be a Mixpanel user property that matches the OneSignal External ID. If you do not select one, Mixpanel will default to using the `$onesignal_user_id` property to match users between OneSignal and Mixpanel. See more about [matching users between OneSignal and Mixpanel](/docs/cohort-sync/integrations/onesignal#matching-users-between-onesignal-and-mixpanel). -![OneSignal 2 Image](/images/onesignal6.png) + ![OneSignal 2 Image](/images/onesignal6.png) -3. You will need to provide two credentials to authorize the connection: **API Key and App ID**. You can find these values in your **OneSignal settings** page. The OneSignal integration will show a **Connected** tag in the UI once the connection succeeds. +3. You will need to provide two credentials to authorize the connection: **API Key and App ID**. You can find these values in your **OneSignal settings** page. The OneSignal integration will show a **Connected** tag in the UI once the connection succeeds. ## Matching Users between OneSignal and Mixpanel - **Warning:** Projects using the [Simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the `$user_id` in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the section below are primarily applicable to projects on the original ID merge system. + **Warning:** Projects using the [Simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the `$user_id` in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the section below are primarily applicable to projects on the original ID merge system. Mixpanel only exports identified user profiles to match to OneSignal - users without user profile properties (i.e., anonymous users) will not export. @@ -44,26 +43,39 @@ To match an exported Mixpanel user to OneSignal, the user’s Mixpanel profile m User profiles without this user property will **not** export to OneSignal - it is a requirement for user matching. -In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$onesignal_user_id` to the user's distinct_id. This ensures that messaging data passed from OneSignal to Mixpanel continues to be attributed to the correct user. +In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$onesignal_user_id` to the user's distinct\_id. This ensures that messaging data passed from OneSignal to Mixpanel continues to be attributed to the correct user. ## Export a Cohort -To export a cohort to OneSignal: - -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort and click **Export to OneSignal**. - -![OneSignal 4 Image](/images/onesignal4.png) - +To export a cohort to OneSignal: + + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the OneSignal destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort and click **Export to OneSignal**. + + + ![OneSignal 4 Image](/images/onesignal4.png) + + + ## Sync Types + This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends OneSignal a static export of users who currently qualify for the cohort. The cohort data will not be updated in OneSignal after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and OneSignal every fifteen minutes. The exported cohort will be updated every fifteen minutes to reflect the most recent list of users in a cohort. ## Select the Segment in OneSignal @@ -71,7 +83,7 @@ In dynamic sync, Mixpanel initiates sync between a cohort and OneSignal every fi Once the export completes, you will see a Segment reflecting the set of users from your Mixpanel cohort: -![OneSignal 5 Image](/images/onesignal5.png) + ![OneSignal 5 Image](/images/onesignal5.png) ## OneSignal Events into Mixpanel & MTU exemptions @@ -83,7 +95,8 @@ Events coming from OneSignal are marked with the property `$source`. Because OneSignal's event structure follows Mixpanel's naming convention for messaging events, it will have the same exemptions outlined in the MTU calculation guide for which events do not count towards MTU tallies. Message delivery events will not count towards a user being in MTU counts, while message engagement events will. The following OneSignal events are exempt from MTU calculations: -- \$app_open (App Opened from Push) -- \$campaign_delivery (Message Sent) -- \$campaign_received (Message Received) -- \$campaign_open (Message Opened) + +- \$app\_open (App Opened from Push) +- \$campaign\_delivery (Message Sent) +- \$campaign\_received (Message Received) +- \$campaign\_open (Message Opened) \ No newline at end of file diff --git a/docs/cohort-sync/integrations/salesforce-marketing-cloud.mdx b/docs/cohort-sync/integrations/salesforce-marketing-cloud.mdx index 8edf9899..501fc6ce 100644 --- a/docs/cohort-sync/integrations/salesforce-marketing-cloud.mdx +++ b/docs/cohort-sync/integrations/salesforce-marketing-cloud.mdx @@ -2,7 +2,6 @@ title: "Salesforce Marketing Cloud" --- - ## Overview This integration lets you export cohorts from Mixpanel to Salesforce Marketing Cloud (SFMC). @@ -26,75 +25,85 @@ This process will require setup on both SFMC and Mixpanel. - **Subdomain** -![SFMC 1 Image](/images/sfmc1.png) + ![SFMC 1 Image](/images/sfmc1.png) 2. Navigate to **Audience Builder → Contact Builder → Data Extensions** to Create a New Data Extension. -![SFMC 2 Image](/images/sfmc2.png) + ![SFMC 2 Image](/images/sfmc2.png) 3. Create a new **Data Extension** with a primary key of the name **SubscriberKey**. The key type for most use-cases will stay as **Text** and size of 250 characters unless you are selecting email or phone number as the id in which you can find corresponding data types. This field will contain ids that map to the unique user property in Mixpanel. -![SFMC 3 Image](/images/sfmc3.png) + ![SFMC 3 Image](/images/sfmc3.png) 4. Note the **External Key** (underlined below) for setup on Mixpanel. -![SFMC 4 Image](/images/sfmc4.png) + ![SFMC 4 Image](/images/sfmc4.png) ### Mixpanel Setup -1. Navigate to **Settings** in the bottom left, then select **Integrations**. - -2. Look for Salesforce Marketing Cloud in the Integrations list and click **Connect**. The following details are needed: +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Salesforce Marketing Cloud, and click **Connect**. The following details are needed: - **Data Extension External Key** -- An optional user property (distinct_id will be used by default). This will sync to the SubscriberKey field -- **client_id**, **client_secret**, **subdomain** +- An optional user property (distinct\_id will be used by default). This will sync to the SubscriberKey field +- **client\_id**, **client\_secret**, **subdomain** -![SFMC 6 Image](/images/sfmc6.png) + ![SFMC 6 Image](/images/sfmc6.png) 3. The SFMC integration will show a **Connected** tag in the UI once the connection succeeds. ## Matching Users between SFMC and Mixpanel - You can select any user property to sync to SFMC as the subscriber key. Once the user ID is set you cannot change it later as this can cause corruption in the Data Extension. If you absolutely need to change this field, you should recreate the Data Extension. -User profiles without the above selected user property will **not** export to SFMC - it is a requirement for user matching. +User profiles without the above selected user property will **not** export to SFMC - it is a requirement for user matching. ## Export a Cohort To export a cohort from Mixpanel to SFMC: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - - -![SFMC 7 Image](/images/sfmc7.png) - - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click Export to > SFMC. Select either one-time sync or dynamic sync. Click **Start Sync**. - - -![SFMC 8 Image](/images/sfmc8.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Salesforce Marketing Cloud destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + + + ![SFMC 7 Image](/images/sfmc7.png) + + + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click Export to \> SFMC. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![SFMC 8 Image](/images/sfmc8.png) + + + ## Sync Types + This integration supports two types of exports: one-time export and dynamic sync. ### One-Time Export + In a one-time export, Mixpanel sends SFMC a static export of users who currently qualify for the cohort. The cohort data will not be updated in SFMC after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and SFMC every 15 minutes. The exported cohort will be updated every 15 minutes to reflect the most recent list of users in a cohort. ## Data Extension in SFMC @@ -102,11 +111,11 @@ In dynamic sync, Mixpanel initiates sync between a cohort and SFMC every 15 minu The cohort data will be exported to the SFMC Data Extension that was set up above. New cohorts are added as property fields to the data extension. -![SFMC 9 Image](/images/sfmc9.png) + ![SFMC 9 Image](/images/sfmc9.png) Each record in the Data Extension is a user and its properties show the membership of this user in different cohorts. -![SFMC 10 Image](/images/sfmc10.png) - + ![SFMC 10 Image](/images/sfmc10.png) + \ No newline at end of file diff --git a/docs/cohort-sync/integrations/segment.mdx b/docs/cohort-sync/integrations/segment.mdx index 7eeea37d..730124d6 100644 --- a/docs/cohort-sync/integrations/segment.mdx +++ b/docs/cohort-sync/integrations/segment.mdx @@ -4,9 +4,10 @@ title: "Segment" ## Overview - This integration allows you to export Cohorts of users from Mixpanel to Segment so that you can better target users across many downstream connections. - - ## Permissions +This integration allows you to export Cohorts of users from Mixpanel to Segment so that you can better target users across many downstream connections. + +## Permissions + You must be a Mixpanel project admin to enable the Segment integration. ## Enable the Integration @@ -15,43 +16,41 @@ This connection requires set up on both Segment and Mixpanel. ### Segment Setup -The connection requires a Segment Write Key. You can obtain this key via Segment's UI: +The connection requires a Segment Write Key. You can obtain this key via Segment's UI: 1. Log into your Segment workspace and click **Sources** under **Connections** in the menu bar on the left. - 2. Click **Add Source** button on the right side above the sources table. - 3. Search for **Mixpanel Cohorts**, select and hit next -![Segment 1 Image](/images/segment1.png) + ![Segment 1 Image](/images/segment1.png) 4. Create a Mixpanel Cohorts source. -![Segment 2 Image](/images/segment2.png) + ![Segment 2 Image](/images/segment2.png) -5. Copy the** Write Key** displayed there. +5. Copy the **Write Key** displayed there. -![Segment 3 Image](/images/segment3.png) + ![Segment 3 Image](/images/segment3.png) ### Mixpanel Setup We will use the Write Key from Segment to enable the connection in Mixpanel. -1. Navigate to **Settings** in the bottom left, then select **Integrations**. -2. Then select Segment, click **Connect**, and paste the** Write Key** that you generated in Segment. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Segment, click **Connect**, and paste the **Write Key** that you generated in Segment. - If you set a User ID Property, it should be a Mixpanel user property that matches the Segment User ID. + If you set a User ID Property, it should be a Mixpanel user property that matches the Segment User ID. -![Segment 5 Image](/images/segment5.png) + ![Segment 5 Image](/images/segment5.png) 3. Click **Continue** to complete the process. @@ -60,31 +59,43 @@ We will use the Write Key from Segment to enable the connection in Mixpanel. To export a Mixpanel cohort into Segment. -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the overflow menu on cohort that you want to export and click Export to... → Segment. - - -![Segment 6 Image](/images/segment6.png) - - -3. Select either one-time sync or dynamic sync, Click **Start Sync**. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Segment destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the overflow menu on cohort that you want to export and click Export to... → Segment. + + + ![Segment 6 Image](/images/segment6.png) + + + 3. Select either one-time sync or dynamic sync, Click **Start Sync**. + + ## Sync Types There are two types of sync: one-time and dynamic. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time + In this sync, Mixpanel sends Segment the static set of users who currently qualify for the cohort. The cohort data will not be updated in Segment after a one-time export. ### Dynamic + In dynamic sync, Mixpanel initiates sync between a cohort and Segment every 15 minutes. The exported cohort will be updated every 15 minutes to reflect the most recent list of users in a cohort. -## Verifying in Segment +## Verifying in Segment + Once the export completes, you can open the debugger on the source you created in Segment above and you'll see "identify" calls flowing in for each user that has been added or removed from the cohort. -![Segment 7 Image](/images/segment7.png) + ![Segment 7 Image](/images/segment7.png) Mixpanel sets a property on the user's profile in Segment indicating whether they are currently part of the cohort. @@ -100,6 +111,7 @@ We send the following identify call to Segment when a user enters the cohort: "userId": "user@email.com" // we use the distinct_id property here } ``` + We send the following when a user exits the cohort: ```json @@ -110,7 +122,4 @@ We send the following when a user exits the cohort: }, "userId": "user@email.com" // we use the distinct_id property here } -``` - - - +``` \ No newline at end of file diff --git a/docs/cohort-sync/integrations/taplytics.mdx b/docs/cohort-sync/integrations/taplytics.mdx index aff30fae..82fa1a1a 100644 --- a/docs/cohort-sync/integrations/taplytics.mdx +++ b/docs/cohort-sync/integrations/taplytics.mdx @@ -2,58 +2,68 @@ title: "Taplytics" --- - ## Overview -Export Mixpanel cohorts to Taplytics to create custom segments that you can apply in your Taplytics experiments, feature flags, and more. Manage the Taplytics integration from the Mixpanel integrations page. +Export Mixpanel cohorts to Taplytics to create custom segments that you can apply in your Taplytics experiments, feature flags, and more. Manage the Taplytics integration from the Mixpanel Destinations page. Taplytics also supports an integration to send experiment data to Mixpanel - for more details, [see the Taplytics Mixpanel integration](https://docs.taplytics.com/docs/guides-integrations-for-ios#mixpanel). ## Permissions + You must be a Mixpanel project admin to enable the Taplytics integration. ## Enable the Integration -To enable the integration with Taplytics: +To enable the integration with Taplytics: -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the Taplytics dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Taplytics, and click **Connect**. -![Taplytics 2 Image](/images/taplytics2.png) + ![Taplytics 2 Image](/images/taplytics2.png) 3. The connection uses one credential to authorize, **API Key**. Supply an API token generated from your **Taplytics settings page** to establish the connection. - 4. The Taplytics integration will show a **Connected** tag in the UI once the connection establishes. ## Matching Users between Taplytics and Mixpanel + Mixpanel only exports identified user profiles to match to Taplytics - users without user profile properties (i.e. anonymous users) will not export. -The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to Taplytics when specifying `userId` to your Taplytics API calls. Taplytics will attempt to match users from inbound cohorts based on their Mixpanel distinct_id. +The integration requires that you use the same system of identifiers for both tools, meaning the value you pass to `mixpanel.identify("internal_user_id")` will have the same value as you pass to Taplytics when specifying `userId` to your Taplytics API calls. Taplytics will attempt to match users from inbound cohorts based on their Mixpanel distinct\_id. ## Export a Cohort To export a Cohort to Taplytics: -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -Click **Export to > Taplytics**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Taplytics destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click **Export to \> Taplytics**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + -![Taplytics 3 Image](/images/taplytics3.png) + ![Taplytics 3 Image](/images/taplytics3.png) ## Sync Types + This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Taplytics a static export of users who currently qualify for the cohort. The cohort data will not be updated in Taplytics after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and Taplytics every two hours. The exported cohort will be updated every day to reflect the most recent list of users in a cohort. ## Select the Segment in Taplytics @@ -61,7 +71,5 @@ In dynamic sync, Mixpanel initiates sync between a cohort and Taplytics every tw Once the export completes, you will see a Segment reflecting the set of users from your Mixpanel cohort in Taplytics's Segment editor, as custom data (e.g. "Beta Users"): -![Taplytics 4 Image](/images/taplytics4.png) - - - + ![Taplytics 4 Image](/images/taplytics4.png) + \ No newline at end of file diff --git a/docs/cohort-sync/integrations/vwo.mdx b/docs/cohort-sync/integrations/vwo.mdx index 25c57c12..4fb8e707 100644 --- a/docs/cohort-sync/integrations/vwo.mdx +++ b/docs/cohort-sync/integrations/vwo.mdx @@ -4,7 +4,7 @@ title: "VWO" ## Overview -Export Mixpanel cohorts to VWO to create custom segments that you can apply in your VWO experiments. Manage the VWO integration from the Mixpanel integrations page. +Export Mixpanel cohorts to VWO to create custom segments that you can apply in your VWO experiments. Manage the VWO integration from the Mixpanel Destinations page. VWO also supports an integration to send experiment data to Mixpanel - for more details, see [the VWO Mixpanel integration](https://help.vwo.com/hc/en-us/articles/900004226426). @@ -14,59 +14,58 @@ You must be a Mixpanel project admin to enable the VWO integration. ## Enable the Integration -To enable the integration: +To enable the integration: -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the VWO dropdown, and select **Connect**. +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select VWO, and click **Connect**. -![VWO 2 Image](/images/vwo2.png) + ![VWO 2 Image](/images/vwo2.png) 3. The connection uses one credential to authorize, **API Key**. Supply an API token generated from your **VWO settings page** to establish the connection. - 4. The VWO integration will show a **Connected** tag in the UI once the connection establishes. ## Matching Users between VWO and Mixpanel + > **Warning:** Projects using the [simplified ID merge system](/docs/tracking-methods/id-management#identity-merge-apis) must have the `$user_id` in Mixpanel match the user identifier in the partner service. Using any alternative partner properties to match users between tools may result in partner events not being attributed to the correct user in Mixpanel. Any partner properties mentioned in the below section are primarily applicable to projects on the original ID merge system. Mixpanel only exports identified user profiles with the user property `$vwo_user_id` to match to VWO - users without user profile properties (i.e. anonymous users) will not export. The value of this property should equal a matching User ID in VWO. If you have the VWO SDK present in your application, it will automatically declare the `$vwo_user_id` property on users' Mixpanel profiles. If the VWO SDK is not on your application, you can declare the user properties either through Mixpanel's own SDKs or HTTP API. VWO will attempt to match users from inbound cohorts based on the value seen on `$vwo_user_id`. -In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$vwo_user_id` to the user's distinct_id. This ensures that experiment data passed from VWO to Mixpanel still attributes to the correct user. +In addition, when our ingestion service detects calls setting this user property, Mixpanel will also auto-alias the value of `$vwo_user_id` to the user's distinct\_id. This ensures that experiment data passed from VWO to Mixpanel still attributes to the correct user. ## Export a Cohort -To export a Cohort to VWO: - -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click **Export to > VWO**. Select either one-time sync or dynamic sync. Click **Start Sync**. -Do note: VWO has a 15MB export limit for profiles in the cohort. - - -![VWO 3 Image](/images/vwo3.png) - +To export a Cohort to VWO: + + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the VWO destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. Do note: VWO has a 15MB export limit for profiles in the cohort. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click **Export to \> VWO**. Select either one-time sync or dynamic sync. Click **Start Sync**. Do note: VWO has a 15MB export limit for profiles in the cohort. + + + ![VWO 3 Image](/images/vwo3.png) + + + ## Sync Types + This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends VWO a static export of users who currently qualify for the cohort. The cohort data will not be updated in VWO after a one-time export. ### Dynamic Sync -In dynamic sync, Mixpanel initiates sync between a cohort and VWO every two hours. The exported cohort will be updated every day to reflect the most recent list of users in a cohort. - - - - - - -Click Export to > VWO. Select either one-time sync or dynamic sync. Click Start Sync. - - +In dynamic sync, Mixpanel initiates sync between a cohort and VWO every two hours. The exported cohort will be updated every day to reflect the most recent list of users in a cohort. \ No newline at end of file diff --git a/docs/cohort-sync/integrations/webengage.mdx b/docs/cohort-sync/integrations/webengage.mdx index 44eae6dd..e3216b78 100644 --- a/docs/cohort-sync/integrations/webengage.mdx +++ b/docs/cohort-sync/integrations/webengage.mdx @@ -1,12 +1,11 @@ --- -sidebarTitle: "WebEngage" title: "Webengage" +sidebarTitle: "WebEngage" --- - ## Overview -Export Mixpanel cohorts to WebEngage to create custom segments that you can apply in your WebEngage campaigns. Manage the WebEngage integration from the Mixpanel integrations page. +Export Mixpanel cohorts to WebEngage to create custom segments that you can apply in your WebEngage campaigns. Manage the WebEngage integration from the Mixpanel Destinations page. ## Permissions @@ -14,16 +13,14 @@ You must be a Mixpanel project admin to enable the WebEngage integration. ## Enable the Integration -To enable the integration: - -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select the WebEngage dropdown, and select **Connect**. +To enable the integration: +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select WebEngage, and click **Connect**. 3. Enter the [WebEngage API Key](https://docs.webengage.com/docs/rest-api-getting-started#getting-your-credentials) from your WebEngage dashboard. -![Webengage 2 Image](/images/webengage2.png) + ![Webengage 2 Image](/images/webengage2.png) 4. The WebEngage integration will show a **Connected** tag in the UI once the connection succeeds. @@ -32,31 +29,42 @@ To enable the integration: Mixpanel only exports identified user profiles to match to WebEngage - users without user profile properties (i.e. anonymous users) will not export. -The exported users are properly mapped in WebEngage's system only if the resolved distinct_id in Mixpanel and the User ID in WebEngage have the same value. If no match is found, WebEngage will create new user profiles for the users exported from Mixpanel. +The exported users are properly mapped in WebEngage's system only if the resolved distinct\_id in Mixpanel and the User ID in WebEngage have the same value. If no match is found, WebEngage will create new user profiles for the users exported from Mixpanel. ## Export a Cohort -To export a Mixpanel Cohort to WebEngage: - -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. -3. Click **Export to WebEngage**. Select either one-time sync or dynamic sync. Click **Start Sync**. +To export a Mixpanel Cohort to WebEngage: - -![Webengage 3 Image](/images/webengage3.png) - + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the WebEngage destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click **Export to WebEngage**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + + ![Webengage 3 Image](/images/webengage3.png) + + + ## Sync Types + This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends WebEngage a static export of users who currently qualify for the cohort. The cohort data will not be updated in WebEngage after the one-time export is complete. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and WebEngage every 30 minutes. The exported cohort will be updated every 30 minutes to reflect the most recent list of users in a cohort. -![Webengage 4 Image](/images/webengage4.png) - - + ![Webengage 4 Image](/images/webengage4.png) + \ No newline at end of file diff --git a/docs/cohort-sync/integrations/xtremepush.mdx b/docs/cohort-sync/integrations/xtremepush.mdx index 085ea6dc..933b4b15 100644 --- a/docs/cohort-sync/integrations/xtremepush.mdx +++ b/docs/cohort-sync/integrations/xtremepush.mdx @@ -2,7 +2,6 @@ title: "Xtremepush" --- - ## Overview The Xtremepush integration allows you to combine behavioral analytics with attribution and engagement data for targeted and relevant customer communication. @@ -19,39 +18,50 @@ You must be a Mixpanel project admin to enable the Xtremepush integration. To enable the integration: -1. Select **Settings > Integrations** tab in the bottom left navigation bar of Mixpanel. - -2. From the Integrations page, select Xtremepush, and select **Connect**. - +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select Xtremepush, and click **Connect**. 3. The Xtremepush integration will show a **Connected** tag in the UI once the connection succeeds. ## Matching Users between Xtremepush and Mixpanel + Mixpanel only exports identified user profiles to match to Xtremepush - users without user profile properties (i.e. anonymous users) will not export. -Xtremepush uses a given user's distinct_id to match the Mixpanel user profile to Xtremepush. As a result, not all exported profiles may match if these values are missing or differ from the emails and phone numbers stored on Insider. +Xtremepush uses a given user's distinct\_id to match the Mixpanel user profile to Xtremepush. As a result, not all exported profiles may match if these values are missing or differ from the emails and phone numbers stored on Insider. Note that exports are used solely for matching user identities between products - the integration will not send the full set of a user's profile properties to Xtremepush, nor will it generate new users. ## Export a Cohort -You can export a cohort to Xtremepush from the Cohorts report. - -1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. - -2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. - -3. Click **Export to Xtremepush**. Select either one-time sync or dynamic sync. Click **Start Sync**. +You can export a cohort to Xtremepush from the Cohorts report. + + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Xtremepush destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to export and configure the sync (one-time or dynamic). Click **Start Sync**. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab to view all of your cohorts. + 2. Select the cohort that you want to export. Click on the three-dot icon on the right side of the cohort. + 3. Click **Export to Xtremepush**. Select either one-time sync or dynamic sync. Click **Start Sync**. + + ## Sync Types + This integration supports two types of exports: one-time export and dynamic sync. When you generate a one-time export or dynamic sync, it overwrites the previous export with an updated export that reflects users who qualify for the cohort at the time of export. ### One-Time Export + In a one-time export, Mixpanel sends Xtremepush a static export of users who currently qualify for the cohort. The cohort data will not be updated in Xtremepush after a one-time export. ### Dynamic Sync + In dynamic sync, Mixpanel initiates sync between a cohort and Xtremepush every two hours. The exported cohort will be updated every two hours to reflect the most recent list of users in a cohort. ## Select the Custom Segment in Xtremepush + Once the export completes, you will see a custom segment reflecting the set of users from your Mixpanel cohort (e.g. "7days-cart-abandoners"): ## Xtremepush Events into Mixpanel & MTU exemptions @@ -63,10 +73,11 @@ Events coming from Xtremepush are marked with the property `$source`. Mixpanel will exempt certain messaging outreach events from MTU calculations, meaning you're free to send campaigns to dormant users without them counting towards MTU billing (only once a user engages with a message will they then be counted towards that tally). The following Xtremepush events are exempt from MTU calculations: -- xp.message.send.batch (EVENT_MESSAGE_SEND_BATCH) -- xp.message.delivery (EVENT_MESSAGE_DELIVERY) -- xp.message.bounce (EVENT_MESSAGE_BOUNCE) -- xp.message.open (EVENT_MESSAGE_OPEN) -- xp.message.click (EVENT_MESSAGE_CLICK) -- xp.message.unsubscribe (EVENT_MESSAGE_UNSUBSCRIBE) -- xp.message.complaint (EVENT_MESSAGE_COMPLAINT) + +- xp.message.send.batch (EVENT\_MESSAGE\_SEND\_BATCH) +- xp.message.delivery (EVENT\_MESSAGE\_DELIVERY) +- xp.message.bounce (EVENT\_MESSAGE\_BOUNCE) +- xp.message.open (EVENT\_MESSAGE\_OPEN) +- xp.message.click (EVENT\_MESSAGE\_CLICK) +- xp.message.unsubscribe (EVENT\_MESSAGE\_UNSUBSCRIBE) +- xp.message.complaint (EVENT\_MESSAGE\_COMPLAINT) \ No newline at end of file diff --git a/docs/cohort-sync/webhooks.mdx b/docs/cohort-sync/webhooks.mdx index c3d3bd9d..3d468d1b 100644 --- a/docs/cohort-sync/webhooks.mdx +++ b/docs/cohort-sync/webhooks.mdx @@ -1,47 +1,69 @@ --- -sidebarTitle: "Webhooks" title: "Syncing cohorts to a custom webhook" +sidebarTitle: "Webhooks" --- -Mixpanel lets you sync cohorts to a custom webhook URL that you provide through the Integrations UI. After you establish a sync, Mixpanel sends the full cohort to the URL and then sends incremental updates that include users who enter or exit the cohort since the previous sync. +Mixpanel lets you sync cohorts to a custom webhook URL that you provide through the Destinations page. After you establish a sync, Mixpanel sends the full cohort to the URL and then sends incremental updates that include users who enter or exit the cohort since the previous sync. This capability allows you to export cohorts to destinations that do not have a [native Mixpanel integration](/docs/cohort-sync/integrations). ## Prerequisites -* A paid Mixpanel plan -* A Mixpanel project -* A webhook server. You can create a dummy webhook for testing purposes using [webhook.site](https://webhook.site/). -* The webhook server should send back events to Mixpanel to track actions like 'Message sent', etc. (This is optional, but customers who need this have to implement it themselves) -Customers can follow the naming convention mentioned in this [document](/docs/admin/pricing-plans#mtu-calculation) to avoid certain events from being considered for MTU tallies. + +- A paid Mixpanel plan +- A Mixpanel project +- A webhook server. You can create a dummy webhook for testing purposes using [webhook.site](https://webhook.site/). +- The webhook server should send back events to Mixpanel to track actions like 'Message sent', etc. (This is optional, but customers who need this have to implement it themselves) Customers can follow the naming convention mentioned in this [document](/docs/admin/pricing-plans#mtu-calculation) to avoid certain events from being considered for MTU tallies. ## Setting up the webhook via our UI -To create a new Custom Webhook destination, navigate to our Integrations UI and add a new Webhook connection. All you need to provide is a name for the connection and the URL of your webhook server. -Optional: Basic Authentication when calling the webhook URL provided +To create a new Custom Webhook destination: + +1. Navigate to **Data** in the nav bar, then select **Destinations**. +2. Click **Add Destination**, select **Webhook**, and click **Connect**. +3. Provide a name for the connection and the URL of your webhook server. Optionally, enable Basic Authentication for calls to the webhook URL. -![image](/images/screen_shot_webhook_cohorts.png) + ![image](/images/screen_shot_webhook_cohorts.png) -From this point onward, you can sync any cohort to this connection from our cohorts page. +From this point onward, you can sync any cohort to this connection. + +### Initialize a Cohort Sync to the Webhook + + + + 1. Navigate to **Data** in the nav bar, then select **Destinations**. + 2. Find the Webhook destination in the list and click on it. + 3. Click the **Syncs** tab, then click **Add Cohort Sync**. + 4. Select the cohort you want to sync and configure the sync. + + + 1. Navigate to **Lexicon**, then select the **Cohorts** tab. + 2. Click the three-dot menu next to the cohort you want to sync and select **Export to... \> Webhook**. + 3. Choose a one-time export or a recurring sync, then click **Start Sync**. + + ### Exported Properties + Mixpanel will automatically include `email`, `mixpanel_distinct_id`, `first_name`, and `last_name` to identify the user. If you need to add extra properties, feel free to add them in the `Properties to Export` field, where we populate some pre-existing fields for you to choose. ## Webhook Format + Our webhook format has the following structure in the body of a `POST` request: -* **action**: The action defines the type of message we are sending. It will be one of: - * `members`: All members of the cohort, sent the first time the cohort is being synced or to refresh the cohort if there are any intermediate errors. When you get this message, replace the users you have in the cohort with the copy provided by us. - * `add_members`: A diff consisting of users who have entered the cohort since the last sync. - * `remove_members`: A diff consisting of users who have exited the cohort since the last sync. -* **parameters** - * **mixpanel_project_id**: the ID for the Mixpanel project that produced this cohort. - * **mixpanel_cohort_id**: unique identifier of the cohort. - * **mixpanel_cohort_name**: The cohort name, editable via the Mixpanel UI. - * **mixpanel_cohort_description**: The cohort description, editable via the Mixpanel UI. - * **mixpanel_session_id**: An identifier for this export. Mixpanel sends large cohorts over multiple messages; mixpanel_session_id uniquely identifies a set of requests that correspond to the same export. - * **page_info**: An object containing “total_pages”, i.e., the number of total messages for the given session ID, and “page_count”, the index of which page this message is (e.g., message 6 of 10, in the example below). You may use this value to know if/when you’ve collected the full set of messages for an export. - * **members**: The list of users being added or removed from the cohort. We include `email`, `mixpanel_distinct_id`, `first_name`, and `last_name` to help identify the user. You may [specify additional properties](/docs/cohort-sync/webhooks#exported-properties) during setup. + +- **action**: The action defines the type of message we are sending. It will be one of: + - `members`: All members of the cohort, sent the first time the cohort is being synced or to refresh the cohort if there are any intermediate errors. When you get this message, replace the users you have in the cohort with the copy provided by us. + - `add_members`: A diff consisting of users who have entered the cohort since the last sync. + - `remove_members`: A diff consisting of users who have exited the cohort since the last sync. +- **parameters** + - **mixpanel\_project\_id**: the ID for the Mixpanel project that produced this cohort. + - **mixpanel\_cohort\_id**: unique identifier of the cohort. + - **mixpanel\_cohort\_name**: The cohort name, editable via the Mixpanel UI. + - **mixpanel\_cohort\_description**: The cohort description, editable via the Mixpanel UI. + - **mixpanel\_session\_id**: An identifier for this export. Mixpanel sends large cohorts over multiple messages; mixpanel\_session\_id uniquely identifies a set of requests that correspond to the same export. + - **page\_info**: An object containing “total\_pages”, i.e., the number of total messages for the given session ID, and “page\_count”, the index of which page this message is (e.g., message 6 of 10, in the example below). You may use this value to know if/when you’ve collected the full set of messages for an export. + - **members**: The list of users being added or removed from the cohort. We include `email`, `mixpanel_distinct_id`, `first_name`, and `last_name` to help identify the user. You may [specify additional properties](/docs/cohort-sync/webhooks#exported-properties) during setup. You can download the Swagger spec [here](https://mxpnl.notion.site/Cohort-Webhook-Yaml-17d35e8ca78245fdbfa0aa4fcbb56596). @@ -79,12 +101,14 @@ You can download the Swagger spec [here](https://mxpnl.notion.site/Cohort-Webhoo ``` ## Expected Response Format + We expect a JSON response of the following shape. -* **action**: Must match the action we sent. -* **status**: Must be either `success` or `failure`. -* **error**: Only expected on failure. - * **message**: details about the error. - * **code**: an HTTP status code. + +- **action**: Must match the action we sent. +- **status**: Must be either `success` or `failure`. +- **error**: Only expected on failure. + - **message**: details about the error. + - **code**: an HTTP status code. ```json { @@ -98,16 +122,20 @@ We expect a JSON response of the following shape. ``` ## Sync + Cohorts are synced once every 30 minutes. The batch size is set to 1000 users per call to `add_members` or `remove_members`. ### Full Sync + Full syncs are only performed when: -* We sync the cohort for the first time. -* We store the snapshot of the cohort state for the last successful sync for 3 days. If your webhook server is down (returns a 429 or 5XX error) for more than 3 days, the snapshot expires, and we do a full sync. + +- We sync the cohort for the first time. +- We store the snapshot of the cohort state for the last successful sync for 3 days. If your webhook server is down (returns a 429 or 5XX error) for more than 3 days, the snapshot expires, and we do a full sync. Subsequent syncs include only differences in membership since the previous successful sync in order to preserve bandwidth, through a [diffing](/docs/cohort-sync/webhooks#diffing) mechanism. ### Diffing + Every time we perform a successful sync to your webhook, we store a snapshot of the cohort as of that time. This snapshot is valid for 3 days. Subsequent syncs use the last successful snapshot of the cohort to compute the number of users added and removed (the diff). We send this diff to your webhook via the `add_members` and `remove_members` calls. ### Example Webhook Sync Scenario @@ -116,27 +144,30 @@ Consider A, B, C, D, E, and F as users. The sync interval is 30 minutes. T repre `add_members(...)` indicates a call to the webhook to add members. `remove_members(...)` indicates a call to remove members. -* **T**: `add_members(A, B, C, D)` | `remove_members()` -* **T+10mins**: B, D leave the cohort -* **T+20mins**: E, F join the cohort -* **T+30mins**: `add_members(E, F)` | `remove_members(B, D)` -* \<...No cohort changes...> -* **T+1h**: `add_members()` | `remove_members()` calls are made to the customer webhook +- **T**: `add_members(A, B, C, D)` | `remove_members()` +- **T\+10mins**: B, D leave the cohort +- **T\+20mins**: E, F join the cohort +- **T\+30mins**: `add_members(E, F)` | `remove_members(B, D)` +- \<...No cohort changes...\> +- **T\+1h**: `add_members()` | `remove_members()` calls are made to the customer webhook ### Failed Syncs + We pause syncs when your server returns a non-transient error (400, 401, 403, 404). Please use the appropriate HTTP status code to indicate a non-transient error; this helps avoid added load. We record failed syncs in our UI and display the error message returned in the response from your webhook server (see the `error.message` field in the sample response above). A notification email is sent to all users who have set up cohort syncs when the syncs pause due to an error. We retry syncs 5 times over 60 secs with exponential backoff in response to 5xx and 429 status codes. After this point, we will wait until the next scheduled sync to retry. -#### Diffs After Failed Syncs +#### Diffs After Failed Syncs + When a sync fails, we do not update the cohort snapshot. The next sync performed will recompute the diff based on the last successful snapshot (until 3 days have passed, at which point we will attempt to sync the full cohort). This ensures that the state of the cohort will converge to what Mixpanel has. -## FAQ -**Does page_count in the requests start from 0 or 1?** +## FAQ + +**Does page\_count in the requests start from 0 or 1?** -The page_count starts from 1. +The page\_count starts from 1. **Are users within the cohort re-synced when webhook calls fail or there is an internal failure?** @@ -156,6 +187,6 @@ The actions are not automatically tracked in Mixpanel as they occur on the custo It's not possible at this moment to edit a webhook's URL; the only available action via UI is to disconnect it. -**How can I delete/remove a webhook from the Integrations page?** +**How can I delete/remove a webhook from the Destinations page?** -It's not possible at this moment to delete or remove a webhook from your project's Integrations page; the only available action via UI is to disconnect it. +It's not possible at this moment to delete or remove a webhook from your project's Destinations page; the only available action via UI is to disconnect it. \ No newline at end of file diff --git a/docs/reports/insights.mdx b/docs/reports/insights.mdx index b744cd6a..2abe7f97 100644 --- a/docs/reports/insights.mdx +++ b/docs/reports/insights.mdx @@ -299,7 +299,7 @@ Use Formulas to make calculations using simple arithmetic operators. Mixpanel supports the following operators: - \+ : Add -- - : Subtract +- \- : Subtract - \* : Multiply - / : Divide - () : Use parentheses to influence the order of operations @@ -533,8 +533,7 @@ Allows you to change the metric being measured. Access by going into the advance ![Rolling and Cumulative](/images/rolling-cumulative.png) -- **Rolling Average:** Rolling analysis calculates the rolling average of the data set. A rolling average curve is a series of averages from subsets of data. Use rolling average analysis to remove noise or spikes from data and smooth out trends over time. Mixpanel calculates the rolling average based on the selected time interval (hour, day, week, month, or quarter) for each data point in the graph.\ - For example, if you make a rolling analysis query for the past 30 days, Mixpanel calculates the rolling 7-day average by default. The value reported on each day in the line graph is the average of the values from the 7 days leading to that day. In the case of the first 6 days in your selected time period, the 7-day-average calculation will include days before the selected time period. +- **Rolling Average:** Rolling analysis calculates the rolling average of the data set. A rolling average curve is a series of averages from subsets of data. Use rolling average analysis to remove noise or spikes from data and smooth out trends over time. Mixpanel calculates the rolling average based on the selected time interval (hour, day, week, month, or quarter) for each data point in the graph.
For example, if you make a rolling analysis query for the past 30 days, Mixpanel calculates the rolling 7-day average by default. The value reported on each day in the line graph is the average of the values from the 7 days leading to that day. In the case of the first 6 days in your selected time period, the 7-day-average calculation will include days before the selected time period. - **Cumulative:** Adds up the values of each point on the graph as it goes along, so the height of the line will increase over time. {/*