Official ruby client interface to the Mixpanel Data API
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config Remove deprecated api_key and expire options Dec 28, 2016
lib Remove unused generate_signature helper method Dec 31, 2016
manual_test Remove deprecated api_key and expire options Dec 28, 2016
spec Remove unused generate_signature helper method Dec 31, 2016
.codeclimate.yml Version bump and codeclimate config. Dec 30, 2016
.document Initial commit to mixpanel_client. Nov 10, 2009
.gitignore
.rubocop.yml Bump version and did some cleanup. Mar 16, 2014
.ruby-version Use latest version of rspec syntax. Sep 29, 2016
.rvmrc Update to ruby 2.0. Mar 15, 2014
Gemfile Using the 'Bundler' method for managing gem. Mar 13, 2011
Rakefile Use the ruby 1.9 hash syntax.' Mar 15, 2014
changelog.md Version bump and codeclimate config. Dec 30, 2016
license Forevva. Mar 15, 2014
mixpanel_client.gemspec Minor copy update. May 1, 2015
readme.md Document the "timeout" option Jun 17, 2017

readme.md

Mixpanel Data API Client

Gem Version Code Climate Codeship Status for keolo/mixpanel_client

Ruby access to the Mixpanel web analytics tool.

Mixpanel Data API Reference

Installation

gem install mixpanel_client

or if you use a Gemfile

gem 'mixpanel_client'

Usage

require 'rubygems'
require 'mixpanel_client'

client = Mixpanel::Client.new(
  api_secret: 'changeme'
  timeout: 240    # Default is 60 seconds, increase if you get frequent Net::ReadTimeout errors.
)

data = client.request(
  'events/properties',
  event:     'splash features',
  name:      'feature',
  values:    '["uno", "dos"]',
  type:      'unique',
  unit:      'day',
  from_date: '2013-12-1',
  to_date:   '2014-3-1',
  limit:     5
)

puts data.inspect

# The API also supports passing a time interval rather than an explicit date range
data = client.request(
  'events/properties',
  event:    'splash features',
  name:     'feature',
  values:   '["uno", "dos"]',
  type:     'unique',
  unit:     'day',
  interval: 7,
  limit:    5
)

# Use the import API, which allows one to specify a time in the past, unlike the track API.
# note that you need to include your api token in the data. More details at:
# https://mixpanel.com/docs/api-documentation/importing-events-older-than-31-days
data_to_import = {'event' => 'firstLogin', 'properties' => {'distinct_id' => guid, 'time' => time_as_integer_seconds_since_epoch, 'token' => api_token}}
require 'base64' # co-located with the Base64 call below for clarity
encoded_data = Base64.encode64(data_to_import.to_json)
data = client.request('import', {:data => encoded_data, :api_key => api_key})
# data == [1] # => true # you can only import one event at a time

Parallel

You may also make requests in parallel by passing in the parallel: true option.

require 'rubygems'
require 'mixpanel_client'

client = Mixpanel::Client.new(
  api_secret: 'changeme',
  parallel:   true
)

first_request = client.request(
  'events/properties',
  ...
)

second_request = client.request(
  'events/properties',
  ...
)

third_request = client.request(
  'events/properties',
  ...
)

...

client.run_parallel_requests

puts first_request.response.handled_response
puts second_request.response.handled_response
puts third_request.response.handled_response

Development

List of rake tasks.

rake -T

Run specs.

rake spec

Run external specs.

cp config/mixpanel.template.yml config/mixpanel.yml
vi config/mixpanel.yml
rake spec:externals

Run rubocop and fix offences.

rubocop

Changelog

Changelog

Collaborators and Maintainers

Contributors

Copyright

Copyright (c) 2009+ Keolo Keagy. See license for details.