GET https://api.usecommune.com/newsletters/{newsletter}/stats Production. There is no separate sandbox host.

Retrieve a newsletter's headline numbers

One snapshot of a newsletter over a window: how the audience moved, what was published, how much the community talked, and how the email performed. It answers the question a dashboard opens with, in one call rather than six.

Every number is scoped to the window. Pick the window with period, or state it exactly with since and until.

Read audience and publishing carefully before charting them. Commune's record of a newsletter's subscribers is complete only for a commune newsletter. For one connected to an outside provider it is a partial cache of that provider's list, which is why the field is called known_subscribers and not subscriber_count. Do not present it as the newsletter's audience size, and ask the provider for that number instead. publishing.sent counts the articles Commune has a record of and is never a count of emails delivered, which lives in delivery.

Needs insights: read. What a key counts depends on whether it acts for the newsletter, which a key does when it holds write in any family. Such a key counts everything, including drafts, scheduled articles and conversations visible only to subscribers. A key that holds only read permissions is a reader of the published newsletter and counts what a reader can see: publishing.sent covers published articles that are not restricted to a tag, publishing.scheduled is null, community.threads, messages and reactions cover public conversations and the replies in them (an article's own discussion is visible to subscribers only, so it is not among them), and community.highlights covers the articles it can read. audience and delivery are the same for both kinds of key.

Path parameters

  • string Required

Query parameters

  • string
  • string
  • string
  • string
  • string

Request Headers

  • string
GET /newsletters/{newsletter}/stats
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-getnewsletterstats

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.