How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Litmus Analytics API

Campaign engagement metrics and breakdowns

Litmus Analytics API is one of 6 APIs that Litmus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://analytics-api.litmus.com/api/v1.

5 operations 5 paths 7 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://instant-api.litmus.com/v1
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Litmus Analytics API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Auth using Litmus account username and password

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Analytics 5

Campaign engagement metrics and breakdowns

GET
/campaigns/{campaignGuid}/summary
Litmus Get campaign engagement summary
getCampaignSummary 1 param → 200401404
GET
/campaigns/{campaignGuid}/clients
Litmus Get campaign email client breakdown
getCampaignClientBreakdown 1 param → 200401404
GET
/campaigns/{campaignGuid}/geo
Litmus Get campaign geographic breakdown
getCampaignGeoBreakdown 1 param → 200401404
GET
/campaigns/{campaignGuid}/devices
Litmus Get campaign device breakdown
getCampaignDeviceBreakdown 1 param → 200401404
GET
/campaigns/{campaignGuid}/read-times
Litmus Get campaign read time distribution
getCampaignReadTimes 1 param → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CampaignSummary (8 properties), ReadTimeBucket (4 properties), GeoBreakdownEntry (4 properties), DeviceBreakdownEntry (3 properties). Each schema is shown below with its type and property counts.

ClientBreakdownEntry
object
Campaign opens attributed to a single email client
3 properties
Error
object
An API error response
2 properties 1 required
GeoBreakdownEntry
object
Campaign opens attributed to a single country
4 properties
ReadTimeDistribution
object
Distribution of recipient read times for a campaign
3 properties
CampaignSummary
object
High-level engagement metrics for an email campaign
8 properties
DeviceBreakdownEntry
object
Campaign opens attributed to a device category
3 properties
ReadTimeBucket
object
A read time engagement bucket with count and percentage
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

litmus-analytics-api-openapi.yml Raw ↑

Other APIs Litmus publishes across the network.

Litmus Campaigns API
Litmus Clients API
Litmus Previews API
Litmus Results API
Litmus Tests API
Where this information came from

This is an independent, third-party profile of Litmus Analytics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.