The tap-mixpanel Meltano extractor pulls data from Mixpanel that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-mixpanel are available. This document describes the default hotgluexyz variant, which is recommended for new users.

Alternative variants are:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the tap-mixpanel extractor to your project using meltano add :

    meltano add extractor tap-mixpanel
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

The settings for extractor tap-mixpanel that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

API Secret (api_secret) #

Mixpanel Project API Secret

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set api_secret <api_secret>

export TAP_MIXPANEL_API_SECRET=<api_secret>

Project Time Zone (project_timezone) #

Mixpanel Project time zone

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set project_timezone <project_timezone>

export TAP_MIXPANEL_PROJECT_TIMEZONE=<project_timezone>

User Agent (user_agent) #

Mixpanel user agent

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set user_agent <user_agent>

export TAP_MIXPANEL_USER_AGENT=<user_agent>

Date Window Size (date_window_size) #

Number of days to use for date window

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set date_window_size 1234

export TAP_MIXPANEL_DATE_WINDOW_SIZE=1234

Attribution Window (attribution_window) #

Minimum number of days to look-back to

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set attribution_window 1234

export TAP_MIXPANEL_ATTRIBUTION_WINDOW=1234

Select Properties by Default (select_properties_by_default) #

Automatically select all props during discovery

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set select_properties_by_default true

export TAP_MIXPANEL_SELECT_PROPERTIES_BY_DEFAULT=true

Denest Properties (denest_properties) #

Denest nested JSON responses from Mixpanel API

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set denest_properties true

export TAP_MIXPANEL_DENEST_PROPERTIES=true

Start Date (start_date) #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mixpanel set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_MIXPANEL_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help? #

If you're having trouble getting the tap-mixpanel extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!