How to get KPIs and metrics from the Email Octopus API

Email Octopus is an email marketing platform offering affordable solutions for creating, sending, and managing email campaigns with automation tools with a REST API giving you access to your lists and list statistics. You can find their documentation here: Email Octopus's API.

Contents

• Authentication
• Endpoint
• How to get your active subscribers count from Email Octopus

Authentication

To access Email Octopus data you need to generate an API token in the API documentation top section.

For any request append a api_key query parameter with this token value to the end to gain access, e.g.

https://emailoctopus.com/api/1.6/lists/?api_key=<your-token>

Endpoint

The primary endpoint to get list statistics is

https://emailoctopus.com/api/1.6/lists/<list-id>

To get your list-id you can request a collection of all your lists from this endpoint:

https://emailoctopus.com/api/1.6/lists/

You currently can’t get historic data for contacts.

How to get your active subscribers count from Email Octopus

To get all contacts send a GET request to and specify the status:

https://emailoctopus.com/api/1.6/lists/<list-id>
  // Authentication
  ?api_key=<your-token>

This will return a list object with a counts property containing the list metrics:

{
  "id": "bbfda348-750d-11ef-b12a-c1ed8de00f64",
  "name": "Test 2",
  "counts": {
    "pending": 0,
    "subscribed": 0,
    "unsubscribed": 0
  },
  "created_at": "2024-09-17T15:58:52+00:00"
}

You can directly use the subscribed value to get your active subscriber count.