Mixpanel

tap-mixpanel (airbyte variant)🥈

Product Analytics Tool

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

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

Alternate Implementations

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
     : 
    2. meltano add extractor tap-mixpanel --variant airbyte
  2. Configure the tap-mixpanel settings using 
    meltano config
     : 
    3. meltano config tap-mixpanel set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-mixpanel test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-mixpanel may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • about
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-mixpanel settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-mixpanel list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Airbyte Config Attribution Window (airbyte_config.attribution_window)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_ATTRIBUTION_WINDOW

A period of time for attributing results to ads and the lookback period after those actions occur during which ad results are counted. Default attribution window is 5 days.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config attribution_window [value]

Airbyte Config Credentials Api Secret (airbyte_config.credentials.api_secret)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_CREDENTIALS_API_SECRET

Mixpanel project secret. See the docs for more information on how to obtain this.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config credentials.api_secret [value]

Airbyte Config Credentials Option Title (airbyte_config.credentials.option_title)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_CREDENTIALS_OPTION_TITLE

Service Account, Project Secret


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config credentials.option_title [value]

Airbyte Config Credentials Secret (airbyte_config.credentials.secret)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_CREDENTIALS_SECRET

Mixpanel Service Account Secret. See the docs for more information on how to obtain this.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config credentials.secret [value]

Airbyte Config Credentials Username (airbyte_config.credentials.username)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_CREDENTIALS_USERNAME

Mixpanel Service Account Username. See the docs for more information on how to obtain this.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config credentials.username [value]

Airbyte Config Date Window Size (airbyte_config.date_window_size)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_DATE_WINDOW_SIZE

Defines window size in days, that used to slice through data. You can reduce it, if amount of data in each window is too big for your environment.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config date_window_size [value]

Airbyte Config End Date (airbyte_config.end_date)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_END_DATE

The date in the format YYYY-MM-DD. Any data after this date will not be replicated. Left empty to always sync to most recent date


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config end_date [value]

Airbyte Config Project Id (airbyte_config.project_id)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_PROJECT_ID

Your project ID number. See the docs for more information on how to obtain this.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config project_id [value]

Airbyte Config Project Timezone (airbyte_config.project_timezone)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_PROJECT_TIMEZONE

Time zone in which integer date times are stored. The project timezone may be found in the project settings in the Mixpanel console.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config project_timezone [value]

Airbyte Config Region (airbyte_config.region)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_REGION

The region of mixpanel domain instance either US or EU.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config region [value]

Airbyte Config Select Properties By Default (airbyte_config.select_properties_by_default)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_SELECT_PROPERTIES_BY_DEFAULT

Setting this config parameter to TRUE ensures that new properties on events and engage records are captured. Otherwise new properties will be ignored.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config select_properties_by_default [value]

Airbyte Config Start Date (airbyte_config.start_date)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_CONFIG_START_DATE

The date in the format YYYY-MM-DD. Any data before this date will not be replicated. If this option is not set, the connector will replicate data from up to one year ago by default.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_config start_date [value]

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-mixpanel

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_MIXPANEL_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_MIXPANEL_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set docker_mounts [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_MIXPANEL_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_MIXPANEL_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_MIXPANEL_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_MIXPANEL_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.


Configure this setting directly using the following Meltano command:

meltano config tap-mixpanel set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

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

Install

meltano add extractor tap-mixpanel --variant airbyte

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-mixpanel
  • Last Commit Date
  • License

Maintainer

  • Airbyte

Keywords

  • airbyte_protocolmeltano_sdk