Skip to content

Latest commit

 

History

History
128 lines (89 loc) · 2.95 KB

README.md

File metadata and controls

128 lines (89 loc) · 2.95 KB
Raw

Mixpanel API Client (for API version 2.0)

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'

config = {'api_key' => 'changeme', 'api_secret' => 'changeme'}
client = Mixpanel::Client.new(config)

data = client.request do
  # Available options
  resource  'events/properties'
  event     '["test-event"]'
  name      'hello'
  values    '["uno", "dos"]'
  timezone  '-8'
  type      'general'
  unit      'hour'
  interval   24
  limit      5
  bucket    'contents'
  from_date '2011-08-11'
  to_date   '2011-08-12'
  on        'properties["product_id"]'
  where     '1 in properties["product_id"]'
  buckets   '5'
end

puts data.inspect

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

Releasing Gem

Update version

vi lib/mixpanel/version.rb

Commit and push local changes

git commit -am "Some message."
git push
git status

Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems

rake release

Changelog

v.2.2.1

  • Added support for the raw data export API.

v2.2.0

  • BASE_URI is now https.
  • Changed funnel to funnel_id.

v2.1.0

  • Updated json dependency to 1.6.

v2.0.2

  • Added timezone to available options.
  • All exceptions can be caught under Mixpanel::Error.

v2.0.1

  • Added options used in segmentation resources.

v2.0.0

  • Manually tested compatibility with Mixpanel gem.

v2.0.0.beta2

  • Added JSON to gemspec for ruby versions less than 1.9.

v2.0.0.beta1

  • Reverted to namespacing via module name because it's a better practice. I.e. Use Mixpanel::Client instead of MixpanelClient.
  • Added 'values' as an optional parameter
  • gem install mixpanel_client --pre

v1.0.1

  • Minor housekeeping and organizing
  • Refactored specs

v1.0.0

  • Changed "Mixpanel" class name to "MixpanelClient" to prevent naming collision in other libraries. a710a84e8ba4b6f018b7

Collaborators and Maintainers

Feel free to add your name and link here.

Keolo Keagy (Author)
Jason Logsdon
James R
Mike Ferrier
Grzegorz Forysinski
Nathan Chong
Paul McMahon
Chad Etzel

Copyright

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