Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Gibbon is an API wrapper for MailChimp's API
Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.document
.gitignore
Gemfile
Gemfile.lock
LICENSE.txt
README.rdoc
Rakefile
VERSION

README.rdoc

gibbon

Gibbon is a simple API wrapper for interacting with MailChimp API 1.3.

Installation

gem install gibbon

Requirements

A MailChimp account and API key. You can see your API keys here.

Usage

Create an instance of the API wrapper:

gb = Gibbon::API.new(api_key)

Fetching data is as simple as calling API methods directly on the wrapper object. Check the API documentation for details.

Fetching Campaigns

For example, to fetch your first 100 campaigns (page 0):

campaigns =  gb.campaigns({:start => 0, :limit => 100})

Fetching Lists

Similarly, to fetch your first 100 lists:

lists = gb.lists({:start => 0, :limit=> 100})

More Advanced Examples

Getting batch member information for subscribers looks like this:

info = gb.list_member_info({:id => list_id, :email_address => email_array})

or

info = gb.listMemberInfo({:id => list_id, :email_address => email_array})

Fetch open and click detail for recipients of a particular campaign:

email_stats = gb.campaign_email_stats_aim({:cid => campaign_id, :email_address => email_array})

or

email_stats = gb.campaignEmailStatsAIM({:cid => campaign_id, :email_address => email_array})

Thanks

  • Rails for camelize gsub

Copyrights

  • Copyright © 2010 Amro Mousa. See LICENSE.txt for details.

  • MailChimp © 2001-2010 The Rocket Science Group

Something went wrong with that request. Please try again.