Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Mixpanel is a business analytics service and tracks user interactions with web and mobile applications and provides tools for targeted communication with them. Its tool set contains in-app A/B tests and user survey forms. Data collected is used to build custom reports and measure user engagement and retention. This plugin will extract raw event-level data from Mixpanel that can be further transformed and enriched with other data sources.

Use case(s)

  • Retrieve raw events data from Mixpanel service

User Storie(s)

  • As a data pipeline developer, I should be be able to retrieve raw Mixpanel events data for specified start and end date so that I can enrich and transform raw data for further analysis
  • As a data pipeline developer, I should be able to specify API secret to authenticate the export request
  • As a data pipeline developer, I should be able to see all the errors while fetching the raw events data from Mixpanel so that I can review and fix those export issues 

Plugin Type

  •  Batch Source
  •  Batch Sink 
  •  Real-time Source
  •  Real-time Sink
  •  Action
  •  Post-Run Action
  •  Aggregate
  •  Join
  •  Spark Model
  •  Spark Compute

Configuration

Marketo batch source will support two different plugins:

  1. Marketo Reporting Plugin - This plugin would get all the Marketo's entities (e.g. Leads, Activities, Campaigns, Companies etc.)
  2. Marketo Entity Plugin - This plugin would get only the data associated with specified entity (e.g. Leads)

Marketo Reporting plugin

This plugin should be used when the user would like to retrieve all of the Marketo datasets, specifically all the entities noted below:

...


Client
User Facing NameTypeDescriptionDefault valueNotes
Client IDstringMarketo Client ID
API Secretstring
Marketo Client secretREST API EndpointstringREST API endpoint URLREST API IdentitystringREST API identityDaily API limitintegerMarketo enforced daily API limit

Additional daily capacity can be purchased and hence user needs to provide this information.

Mixpanel API secret
https://
developers
developer.
marketo
mixpanel.com/docs/
rest
exporting-
api/marketo
raw-
integration
data#section-
best
required-
practices/Report formatstringReport formatCSVOptions are CSV, TSV or SSVStart
parameter
From datestringStart date for reports data
ISO 8601

YYYY-MM-DD format
End
To datestringEnd date for reports data
ISO 8601 format

YYYY-MM-DD format
Eventsmulti-selectComma separated list of events you would like to get data on
Optional
FilterstringExpression to filter events by
Optional


Design / Implementation Tips

...

  • Mixpanel only supports batch source so there will not be any streaming source for Mixpanel
  • Data export API always returns data in JSON format.
  • API details provide best practices around API usage 

Design

Approach(s)

Properties

...