MixPanel Integration

Overview

The ClientSuccess MixPanel integration uses a direct connection via API to the MixPanel system to ingest usage data and events into ClientSuccess.  The events can then be viewed in ClientSuccess as usage metrics to help determine the health of the customer based on usage.

Integration Setup

The integration currently requires the assistance of the ClientSuccess Technical Team to install, set up and configure the usage events to be synchronized into ClientSuccess.  There are 4 prerequisites needed for the initial installation and configuration:

Pre-reqs

1. A new MixPanel “Service Account” with Admin access
2. MixPanel Secret from the Service Account
   • (Note: Please make note of the password for future use.)
3. The ProjectID from the MixPanel Account
4. A list of events that you want to consume for usage data into ClientSuccess.
   • (Note: Events must be formatted properly in the “Your Properties” tab below.)

Things To Know

• The MixPanel integration is designed to capture usage data events and present them in the ClientSuccess Usage Data app
• The MixPanel integration will retrieve data from MixPanel once a day
• Events listed in Pre-rec #4 above must conform to the events format specified in section 4 below.

How To Get Started

1. MixPanel Service Account - Create a MixPanel Service Account with the Admin role. 

2. The ClientSuccess technical team will need the MixPanel Service Account name and Secret for setup and configuration in the ClientSuccess platform. See example below:
   • Account Name: my_service_account.xxxxxx.mp-service-account
   • Secret: RXeFcydrvj0RxX0RVk9FLA4s4I8DYMJq  [Example]

3. MixPanel ProjectId - You will also need the MixPanel ProjectId to link to the proper MixPanel account.

4. From the list of events in MixPanel, determine which events you want to track.  Here’s a an example of where you can find these possible usage events in MixPanel.
   5. Usage Event Setup - Once you have determined which events you would like to track and measure, then you will need to enhance/tweak the event data sent to Mixpanel so the data can be collected and stored in the ClientSuccess Platform.

   This will likely need to be done by a tech team or developer familiar with how events are sent to the Mixpanel account. Note: This is usually done via code/SDK by client-side tracking (like javascript snippet that captures clicks/navigation in an app) or leveraging Mixpanel’s API (server-side tracking). See Choosing the Right Method - Mixpanel Docs for more information.

   The tech team/person will need to change the integration data events needed to be ingested by the ClientSuccess platform by adding in a few additional properties. The following fields are required in order to capture the usage data properly:

   • event

   • identity.organization.Id

   • identity.organization.Name

     Below is an example of how the events must be formatted so they can be ingested directly into ClientSuccess via the integration.

{

  "event": "Signed UP!",

  "properties": {

    "time": 1655888864,   

    "identity": {

    "organization": {

  "id": "6",

  "name": "Big Company"

    },

    "user": {

  "email": "rjones@emaildomain.com",

  "id": "131",

  "name": "Ryan Jones"

    }

    },

    "timestamp": "2022-06-22T02:10:39",

    "value": 1

  }

  }

For example, look at “Your Properties” tab in the screenshot below.  You will need to build an event structure similar to this.

Note:  Only the Identity section with Organization, id, and name are required to bring usage data in at the customer level.  (The “user” section is optional.)

Once you have entered the proper format for the events, please contact your CSM or support with that information (specifically the list of events) so we can update the integration in ClientSuccess.

Exporting MixPanel Data

Please see the following documentation for instructions on how to export the MixPanel data.  Export MixPanel Data

If you have any questions or need more information on the MixPanel Integration, please contact your CSM or Support.