Our Email Analytics tool lets you track incredibly detailed data for your email campaigns. Email Analytics is available to all Litmus customers on our Plus plan or above.

Email Analytics works by embedding a piece of HTML tracking code at the bottom of your email template when you send it. If you send a lot of campaigns and would like to automate the generation of these tracking codes then you'll find Email Analytics API very useful.

The Email Analytics API is part of our regular Litmus Customer API. This is enabled for every paid Litmus account. If you don't already have a Litmus account you can sign up on our website.

Terminology

When using the Email Analytics API you'll be working with Mailing Lists and Campaigns. A mailing list is pretty self-explanatory - it's a collection of recipients to whom you send marketing emails. A mailing list can be any size, from a few hundred people to millions. A campaign is one email sent out to a mailing list. You can track up to 30 campaigns per month to a mailing list using Litmus Email Analytics. The number of total mailing lists you can track depends on your Litmus price plan.

Mailing lists

Mailing lists are known as Lists within the API. You can perform the following actions on Lists via the API:

• Index: Returns a list of all the mailing lists in your Litmus account
• Show: Returns the details of a single mailing list 
• Create: Lets you create a new mailing list in your Litmus account 

Campaigns

Campaigns are known as Reports within the API (a little confusing, we know). You can perform the following actions on Reports via the API:

• Index: Returns a list of all the campaigns for a particular mailing list
• Show: Returns the details of a single campaign for a particular mailing list 
• Create: Lets you create a new campaign (and get the tracking code) for a particular mailing list 

Common use case

The most common use case for the Email Analytics API is to generate new tracking codes for a mailing list that's already been set up. The API call you'll use to do this is reports/create. With your API request you'll need to send the ID of the mailing list you want to create a campaign for. You can find this within Litmus by looking at the URL in your browser.

Visit the Analytics tab within your Litmus account and click through to one of your campaigns. If you look at the URL you'll see something similar to:

http://salted.litmusapp.com/analytics/100/reports/200

In our example, the ID of the mailing list is 100. You can then use this ID in your request, and the API will return a new tracking code for your next campaign to that mailing list.

Support

If you need assistance while using our API, please email hello@litmusapp.com and we'll be delighted to help!