Skip to main content

Crawl Mixpanel

Connect docs via MCP
TL;DR

Crawl metadata from Mixpanel to catalog events, event properties, and user (profile) properties, and enable daily write-back of certified descriptions to Mixpanel Lexicon.

Extract metadata from your Mixpanel project into Atlan to discover and govern your product-analytics tracking plan. After providing your Mixpanel service account and Atlan credentials, you can catalog events, event properties, and user (profile) properties, and enable daily write-back of certified descriptions to Mixpanel Lexicon. Review the order of operations and then complete the following steps.

Select source​

To select Mixpanel as your source:

  1. In the top navigation, click Marketplace.
  2. Search for Mixpanel and select it.
  3. Click Install.
  4. Once installation completes, click Setup Workflow on the same tile.

If you navigated away before installation completed, go to New > New Workflow and select Mixpanel to proceed.

Provide credentials​

On the Credentials step, provide the Mixpanel service account and Atlan credentials you gathered when setting up Mixpanel:

  1. For Service Account Username, enter your Mixpanel service account username.
  2. For Service Account Secret, paste the service account secret. The field is masked.
  3. For Atlan Base URL, enter your Atlan tenant URL—for example https://your-tenant.atlan.com.
  4. For Atlan API Key, paste your Atlan API token. The field is masked.
  5. Click the Test Authentication button to confirm connectivity to both Mixpanel and Atlan using these details.
  6. Once successful, at the bottom of the screen, click Next.
Why does the app ask for Atlan credentials?

Unlike a read-only crawler, the Mixpanel app runs on the Atlan side and writes back to your workspace: it authors the Mixpanel assets, glossary terms, and custom metadata, and reads the certified descriptions it later pushes to Lexicon. It authenticates to Atlan with the API token you provide here. See setting up Mixpanel for the permissions the token needs.

Configure connection​

On the Connection step, select or create the Atlan connection for this Mixpanel project:

  1. Select an existing Mixpanel connection, or create a new one. All Mixpanel events, event properties, and user properties from this run live under this connection.

  2. (Optional) To change the users able to manage this connection, change the users or groups listed under Connection Admins.

    warning

    If you don't specify any user or group, nobody can manage the connection—not even admins.

  3. At the bottom of the screen, click Next to proceed.

Configure workflow​

On the Configuration step, tell the app which Mixpanel project to catalog:

  1. For Mixpanel Project ID, enter the numeric project ID you copied from Mixpanel project settings—for example 12345678. This scopes the crawl to a single Mixpanel project.
  2. (Optional) For Connection Name, enter a display name for this Mixpanel connection in Atlan—for example Mixpanel-Production. If you leave it blank, the app defaults to Mixpanel-{project_id}.
  3. At the bottom of the screen, click Next to proceed.

Run crawler​

To run the Mixpanel crawler, after completing the steps in this guide:

  1. To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
  2. You can either:
    • To run the crawler once immediately, at the bottom of the screen, click the Run button.
    • To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule Run button.

Once the crawler has completed running, your Mixpanel events, event properties, and user properties are available under the Assets page and can be governed with terms, classifications, ownership, and custom metadata like any other Atlan asset! 🎉

Descriptions you certify in Atlan are pushed back to Mixpanel Lexicon on the app's daily write-back cadence, keeping the definitions your stewards write visible to analysts working in Mixpanel.

What's next?​