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

Commune Metrics API

The rolled up numbers for a newsletter and for one article: headline statsfor a period, acquisition attribution, bucketed series for charting, andone article's email performance beside its community response. What adashboard reads, where Engagement is what an automation reads. Creatorscope, and part of the one read surface Commune may put behind a plan.

Commune Metrics API is one of 18 APIs that Commune publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2026-08-26.

Requests are made against a single base URL, https://api.usecommune.com.

4 operations 4 paths 19 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-08-26
Base URL
https://api.usecommune.com
Authentication
OAuth 2.0, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Commune Metrics API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 13 scopes. It accepts HTTP bearer tokens (Commune API key) (apiKey). By default, every request must be authenticated.

  • oauth2 — An OAuth access token, sent as Authorization: Bearer . The walkthrough of the whole flow is at [usecommune.dev/use-cases/build-an-integration](https://usecommu…
  • apiKey — A Commune API key, sent as Authorization: Bearer . A key is granted one or more newsletters and carries six permission families on each, every one of them none…

Paths & Operations 4

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

Metrics 4

The rolled up numbers for a newsletter and for one article: headline stats for a period, acquisition attribution, bucketed series for charting, and one article's email performance…

GET
/newsletters/{newsletter}/stats
Retrieve a newsletter's headline numbers
getNewsletterStats 7 params → 200400401403404429500
GET
/newsletters/{newsletter}/growth
Retrieve a newsletter's acquisition breakdown
getNewsletterGrowth 7 params → 200400401403404429500
GET
/newsletters/{newsletter}/timeseries
Retrieve one newsletter metric bucketed over time
getNewsletterTimeseries 8 params → 200400401403404429500
GET
/articles/{article}/stats
Retrieve one article's performance
getArticleStats 4 params → 200400401403404429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Article (18 properties), Thread (16 properties), Newsletter (16 properties), SocialLinks (8 properties). Each schema is shown below with its type and property counts.

ArticleStatus
string
Where an article is in its life. A credential holding only read permissions ever sees sent and nothing else. An imported article is always sent, since Commune…
SocialLinks
object
The creator's other homes on the internet, stored as canonical profile URLs. Every key is optional and a newsletter that set none returns an empty object.
8 properties
ArticleStats
object
Engagement counts for an article, computed at read time. These are Commune side counts, not provider side email metrics: opens, clicks and deliveries are not h…
3 properties 3 required
TimeseriesInterval
string
How wide each bucket is. A week starts on Monday and a month on the first, both in UTC, so buckets line up across two newsletters in different time zones.
User
object
A person's public profile, and the whole of what this API returns about anybody other than the credential's own owner. Email address, theme, notification prefe…
5 properties 2 required
Ref
object
An unexpanded relationship. Ask for the relationship in ?expand= to get the full object in its place.
2 properties 2 required
Media
object
An image or file attached to a thread or a message.
3 properties 1 required
Thread
object
A conversation in a newsletter's community, together with the message that opened it. Its replies are a separate collection.
16 properties 8 required
NewsletterStats
object
A newsletter's headline numbers over one window: audience movement, what was published, community activity and email performance. Nothing here is a running tot…
8 properties 8 required
Error
object
The error envelope. Every non 2xx response from every operation has this shape, so a client can branch on error.code without knowing which operation produced i…
1 property 1 required
Esp
string
Where a newsletter is published from. commune means Commune itself sends the email. Every other value is an email service provider whose posts Commune imports.…
TimeseriesMetric
string
Which quantity a series buckets. Each value is a count of things that happened inside a bucket, never a running total, so a client that wants a cumulative line…
ArticlePerformance
object
One article measured on both sides at once: what the email did, and what the community did with it afterwards. Not to be confused with ArticleStats, the small…
4 properties 4 required
Timeseries
object
One metric bucketed over a window. The shape a chart consumes, and the only operation in this domain that is not a snapshot.
7 properties 7 required
Newsletter
object
A newsletter and its public profile. Nothing operational is exposed: ESP credentials, OAuth tokens, group and audience ids, feed polling state and language det…
16 properties 6 required
Article
object
One article of a newsletter, without its body. Every collection of articles returns this shape. GET /articles/{article} returns ArticleWithContent, which is th…
18 properties 8 required
ThreadVisibility
string
Where a thread is placed. public puts it on the global Commune feed and makes it readable by anyone. subscribers keeps it inside the newsletter. paid narrows i…
NewsletterGrowth
object
Where a newsletter's new subscribers came from inside one window.
5 properties 5 required
ErrorCode
string
The stable, machine readable reason a request failed. New codes may be added in a minor version, so treat an unrecognised code as a generic failure of its HTTP…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

usecommune-metrics-api-openapi.yml Raw ↑

Other APIs Commune publishes across the network.

Commune Articles API
Commune Engagement API
Commune Event delivery API
Commune Highlights API
Commune Messages API
Commune Newsletters API
Commune Platform API
Commune Search API
Commune Senders API
Commune Sends API
Commune Subscriber tags API
Commune Subscribers API
Where this information came from

This is an independent, third-party profile of Commune Metrics 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.