README.md

In sckott/chimpr: 'Mailchimp' API Client

chimpr

Mailchimp API docs API reference

Authentication

Get a Mailchimp API key at https://mailchimp.com/developer/

Keep this key private. You can pass the key in to each function via the key parameter, but it's better to store the key as an environment variable (MAILCHIMP_KEY).

Read only for now

We're sticking to read only (i.e., GET) methods for now.

Package API

The R6 classes ChmpCampaigns, ChmpList, and ChmpReports have methods on them that you can call for various API routes under each high level topic. Generally an id is required (e.g., campaign id, list id, report id), but there are some methods that don't require an id.

• chmp_ping - ping
• chmp_root - API root
• chmp_lists/chmp_lists_ - get all lists
• ChmpCampaigns - methods for campaigns
• ChmpList - methods for individual lists
• ChmpReports - methods for reports

High vs. Low level package APIs

High level API

parse to a list or data.frame

Low level API

just get some JSON

Rate Limiting

...

Install

Development version

remotes::install_github("sckott/chimpr")

library("chimpr")

lists

all lists

# JSON
chmp_lists_()
# parse to data.frame where possible
chmp_lists()
# parse to a list
chmp_lists(parse = FALSE)

Meta

• Please report any issues or bugs.
• License: MIT
• Get citation information for chimpr in R doing citation(package = 'chimpr')
• Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

sckott/chimpr documentation built on Sept. 17, 2021, 11:04 a.m.