> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/mixpanel/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Install with AI [BETA]

> Use AI to install Mixpanel in your application

This guide will help you add Mixpanel analytics to your app or website using AI assistance, even if you're not a developer. The Mixpanel Installation Wizard creates step-by-step instructions that you can give to AI coding tools like Claude, ChatGPT, or Cursor.

## What You'll Need

Before starting, make sure you have:

* A Mixpanel account with Admin or Owner access ([sign up](https://www.mixpanel.com/signup) if you don't have one)
* Access to an AI coding assistant (Claude, ChatGPT, Cursor, etc.)
  * Be sure to use the most advanced AI model you have access to
* Your project's code files and a development or staging environment to test the changes

## Step 1: Get Your Mixpanel Project Token

<Steps>
  <Step title="Log into Mixpanel">
    Log into your [Mixpanel account](https://www.mixpanel.com/login)
  </Step>

  <Step title="Open Project Settings">
    Go to your [project settings](https://www.mixpanel.com/settings/project) (gear icon in the bottom left)
  </Step>

  <Step title="Find Your Token">
    Click on "Overview" in the left sidebar. Scroll down to Access Keys section and copy your "Project Token" - it looks like a long string of letters and numbers.

    <Note>
      You will need to be an Admin or Owner in your project
    </Note>
  </Step>

  <Step title="Keep It Handy">
    Save this token - you'll need it in the next step
  </Step>
</Steps>

## Step 2: Create Your AI Instructions

<Steps>
  <Step title="Run the Wizard">
    Simply paste this command in your terminal:

    ```bash theme={null}
    npx @mixpanel/mixpanel-wizard
    ```
  </Step>

  <Step title="Answer Questions">
    Go through and answer a few quick questions and it will then create a customized installation guide
  </Step>
</Steps>

### Choose Your Settings

You'll need to pick three things:

#### A. Choose Your SDK Type

This depends on what type of app or website you're building:

<Tabs>
  <Tab title="Web">
    * **`javascript`** - For web applications
  </Tab>

  <Tab title="Mobile">
    * **`react-native`** - For React Native apps
    * **`ios-swift`** - For iOS apps in Swift
    * **`ios-objective-c`** - For iOS apps in Objective-C
    * **`android`** - For Android apps
    * **`flutter`** - For Flutter apps
  </Tab>

  <Tab title="Server">
    * **`python`** - For Python backends
    * **`nodejs`** - For Node.js backends
    * **`go`** - For Go backends
    * **`ruby`** - For Ruby backends
    * **`php`** - For PHP backends
    * **`java`** - For Java backends
  </Tab>

  <Tab title="Gaming">
    * **`unity`** - For Unity games
  </Tab>
</Tabs>

<Info>
  Don't see your platform? Check with a developer or choose the closest match.
</Info>

#### B. Choose Your Event Type

This determines what kinds of user actions you'll track:

* **`ai`** - Best for AI-powered features (chatbots, AI tools, ML features)
* **`ecommerce`** - Best for online stores and shopping apps
* **`default`** - Good general-purpose events for most other apps

#### C. Decide on Extra Features

* **Autocapture** - Automatically tracks clicks and page views (JavaScript SDK only)
* **Session Replay** - Records user sessions for debugging (JavaScript, iOS Swift, Android SDKs only)

<Tip>
  Recommendation: Enable both if they're available for your platform
</Tip>

## Step 3: Give Instructions to Your AI Assistant

<Steps>
  <Step title="Open Your AI Tool">
    Open your AI coding tool (Claude, ChatGPT, Cursor, etc.)
  </Step>

  <Step title="Copy Installation File">
    Copy over the instruction file generated from step 2 to your project
  </Step>

  <Step title="Provide File Access">
    Make sure the AI has access to your project files
  </Step>

  <Step title="Send the Prompt">
    Copy and paste this prompt into your AI Agent:

    ```
    Let's set up Mixpanel.
    1. Set up mixpanel by following the steps in MIXPANEL_INSTALLATION_INSTRUCTIONS.txt. Make sure to follow the global rules specified in the MIXPANEL_INSTALLATION_INSTRUCTIONS.txt.
    2. After completing the steps in the installation guide, delete the MIXPANEL_INSTALLATION_INSTRUCTIONS.txt
    ```
  </Step>

  <Step title="Let AI Complete">
    Let the AI complete all the steps. The AI will:

    * Follow the generated setup instructions
    * Install the necessary code
    * Set up tracking for your chosen events
  </Step>
</Steps>

## Step 4: Test Your Installation

After the AI completes the setup, test that everything is working:

### Quick Test

<Steps>
  <Step title="Deploy Changes">
    Deploy the changes to your testing environment
  </Step>

  <Step title="Use Your App">
    Use your app or website normally
  </Step>

  <Step title="Check Mixpanel">
    Go to your Mixpanel dashboard and click on "Events" in the left sidebar or visit the [Events page](https://mixpanel.com/report/events)
  </Step>

  <Step title="Verify Events">
    You should see events flowing in as you use your app (you may need to refresh Mixpanel)
  </Step>
</Steps>

### What to Look For

Depending on your event type, you should see:

<Tabs>
  <Tab title="AI Events">
    * **Launch AI** when AI features are used
    * **AI Prompt Sent** when users send prompts
    * **AI Response Sent** when AI responds
  </Tab>

  <Tab title="E-commerce Events">
    * **Product Viewed** when products are viewed
    * **Add to Cart** when items are added to cart
    * **Purchase** when transactions complete
  </Tab>

  <Tab title="Default Events">
    * **Sign Up** for new user registrations
    * **Page View** for page visits
    * **Search** for search queries
  </Tab>
</Tabs>

## Command Line Mode

Skip the interactive prompts by providing options directly:

```bash theme={null}
# Basic usage
mixpanel-wizard --token YOUR_TOKEN --sdk javascript --events ai

# With additional options
mixpanel-wizard --token YOUR_TOKEN --sdk javascript --autocapture --sessionreplay --events ecommerce

# With approval for each code change
mixpanel-wizard --token YOUR_TOKEN --sdk javascript --confirm-each --events ai

# iOS with specific package manager
mixpanel-wizard --token YOUR_TOKEN --sdk ios-swift --events default
```

### Available Options

| Option            | Description                                                    | Values                                                                                                                                      |
| ----------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `-t, --token`     | Your Mixpanel project token                                    | String                                                                                                                                      |
| `--sdk`           | SDK type to install                                            | `javascript`, `flutter`, `ios-objective-c`, `ios-swift`, `android`, `react-native`, `go`, `python`, `ruby`, `php`, `nodejs`,`java`, `unity` |
| `--events`        | Additional event type options                                  | `ai`, `ecommerce`, `default`                                                                                                                |
| `--autocapture`   | Enable autocapture (JavaScript only)                           | Boolean flag                                                                                                                                |
| `--sessionreplay` | Enable session replay (Javascript, iOS Swift and Android Only) | Boolean flag                                                                                                                                |
| `--confirm-each`  | Require approval for each code change made by AI               | Boolean flag                                                                                                                                |

## Event Templates

### Default Events

* **Sign Up**: Track new user acquisition with signup method and UTM parameters
* **Sign In**: Monitor user login events with authentication method tracking
* **Page View**: Track page/screen views with URL and title information
* **Search**: Capture search queries and result counts
* **Error**: Monitor application errors with error types and messages
* **Purchase**: Track completed transactions with revenue and currency data
* **Conversion**: Monitor key value moments specific to your product type

### AI Events

* **Launch AI**: Track AI feature engagement and measure adoption patterns
* **AI Prompt Sent and Prompt Text**: Capture user prompts and analyze engagement intent
* **AI Response Sent**: Monitor AI outputs with cost, token usage, and response time metrics
* **API Error**: Track AI feature errors and monitor failure rates
* **User Feedback**: Collect user sentiment and feedback on AI interactions
* **AI Dismissed**: Monitor AI feature disengagement points
* **Conversion Event**: Measure how AI features influence key business outcomes

### E-commerce Events

* **Purchase**: Track completed transactions with cart contents and total price
* **Add to Cart**: Monitor shopping behavior with cart items and product categories
* **Product Viewed**: Track product engagement across the purchasing funnel
* **Ad Data**: Monitor advertising spend and cost data for ROI calculations

<Warning>
  This tool generates AI-optimized installation instructions. Always review and test the generated code before deploying to production. Human oversight is strongly recommended for all integrations.
</Warning>

## Troubleshooting

<AccordionGroup>
  <Accordion title="No Events Showing Up?">
    1. Check that you used the correct project token
    2. Verify your app is running and being used
    3. Wait a few minutes - sometimes there's a delay
    4. Check the browser console (F12) for any error messages
  </Accordion>

  <Accordion title="Wrong Events Tracking?">
    1. Make sure you chose the right event type in Step 2B
    2. Ask your AI assistant to show you what events are being tracked
    3. You can always re-run the setup with different event types
  </Accordion>

  <Accordion title="Need Help?">
    1. Check the Mixpanel documentation at [docs.mixpanel.com](https://docs.mixpanel.com/)
    2. Ask your AI assistant to explain what it installed
    3. Contact [Mixpanel support](https://mixpanel.com/contact-us/support/) through our help center
  </Accordion>
</AccordionGroup>

## Success!

Once you see events flowing into your Mixpanel dashboard, you're all set! You can now:

* View real-time user activity
* Create reports and dashboards
* Set up alerts for important events
* Analyze user behavior patterns

The AI has set up all the technical details for you - now you can focus on understanding your users and growing your product.