Litmus

Litmus Campaigns API

Email campaign tracking and management

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 38

GET /campaigns Litmus List campaigns #
POST /campaigns Litmus Create a campaign #
GET /campaigns/{campaignGuid} Litmus Get a campaign #
DELETE /campaigns/{campaignGuid} Litmus Delete a campaign #
GET /api/v1/Campaigns/{guid}/MailClientUsageReport Get mail client usage report for campaign #
POST /api/v1/Campaigns/OpenCounts Get open counts from a set of campaigns #
GET /api/v1/Campaigns/OpenCountsForUser/{userGuid}/{fromDate}/{untilDate} Get a set of campaign open counts for a given period for a user #
GET /api/v1/Campaigns/{guid}/RenderingCategoryReport Get rendering category report for campaign #
GET /api/v1/Campaigns/{guid}/GroupUsageReport Get group usage report for campaign #
GET /api/v1/Campaigns/{guid}/BrowserUsageReport Get browser usage report for campaign #
POST /api/v1/Campaigns Create a new campaign #
PUT /api/v1/Campaigns/{guid} updates an existing campaign #
PUT /api/v1/Campaigns/{guid}/Start Start a campaign #
PUT /api/v1/Campaigns/{guid}/Restart Restart a campaign with a new expiration date #
PUT /api/v1/Campaigns/{guid}/Clear Clear all campaign data #
PUT /api/v1/Campaigns/{guid}/ClearIndividual Clear individual data for a campaign but retain aggregated data #
POST /api/v1/Campaigns/ConfigureNotificationEndpoint Configure campaign notifications #
PUT /api/v1/Campaigns/{guid}/Subscribe Subscribe to notifications for a campaign #
PUT /api/v1/Campaigns/{guid}/UnSubscribe Unsubscribe to notifications for a campaign #
POST /api/v1/Campaigns/Get Get campaign data from a set of campaigns #
POST /api/v1/Campaigns/OpenCounts/{year}/{month} Get several campaign open counts from a given month #
POST /api/v1/Campaigns/OpenCounts/{fromDate}/{untilDate} Get a set of campaign open counts for a given period #
GET /api/v1/Campaigns/OpenCountsForUser/{userGuid}/{monthDate} Get a set of campaign open counts for a given month for a user #
POST /api/v1/Campaigns/Campaigns/OpenCountsByMonth Get a set of campaign open counts by month #
POST /api/v1/Campaigns/Campaigns/AdvancedOpenCounts Get advanced open counts for a set of campaigns #
GET /api/v1/Campaigns/{guid}/ActivityReport Get activity report for campaign #
GET /api/v1/Campaigns/{guid}/ActivitySummaryReport Get activity summary report for campaign #
GET /api/v1/Campaigns/{guid}/EngagementReport Get engagement report for campaign #
GET /api/v1/Campaigns/{guid}/DetailedEngagementReport Get detailed engagement report for campaign #
GET /api/v1/Campaigns/{guid}/GroupEngagementReport Get group engagement report for a campaign #
GET /api/v1/Campaigns/{guid}/MailClientEngagementReport Gets a report describing engagement at the user agent level #
GET /api/v1/Campaigns/{guid}/DetailedMailClientEngagementReport Get mail client engagement report for campaign #
GET /api/v1/Campaigns/{guid}/GeolocationReport Get geolocation report for campaign #
POST /api/v1/Campaigns/Compare Get a comparable report for a set of campaigns #
GET /api/v1/Campaigns/AllExpiringGuids/{untilDate} Get all expiring guids until a given date #
PUT /api/v1/Campaigns/SetExpiration/{guid} Set a new expiration date for a campaign #
PUT /api/v1/Campaigns/SetToNeverExpire/{guid} Sets a single campaign to never expire #

Documentation

📖
Documentation
https://docs.litmus.com/instant
📖
Authentication
https://docs.litmus.com/oauth-integration-guide
📖
Documentation
https://docs.litmus.com/legacy-previews
📖
Documentation
https://docs.litmus.com/email-analytics

Specifications

⚙
OpenAPI
https://artifacts.apis.io/litmus/openapi/litmus-campaigns-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/litmus:litmus-campaigns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

litmus-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Litmus Campaigns API
  version: '1.0'
  description: 'Operations tagged Campaigns across 2 of this provider''s published API definitions: litmus-email-analytics-openapi.yml, litmus-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://analytics-api.litmus.com/api/v1
  description: Litmus Email Analytics API Production Server
- url: https://analytics-api.litmus.com
tags:


# --- truncated at 32 KB (65 KB total) ---
# Full source: https://artifacts.apis.io/litmus/openapi/litmus-campaigns-api-openapi.yml