List a newsletter's sends
Every dispatch this newsletter has made, most recent first, with the numbers each one finished on. Needs sending: read.
A send is one run rather than one article. An article that went out once has one; an article that failed and was sent again has two, and ?article= narrows the collection to one article's runs. An article imported from an outside provider has none, because that provider mailed it, and neither has an article whose audience worked out to nobody.
The three counts are the three a send.completed event publishes, under the same names, so a consumer holding a stored event and a caller reading this back are holding one set of numbers rather than two spellings of them. Send says what each one counts and what none of them counts.
Expanding article inlines an Article, which is content rather than sending, so it also needs content: read on this newsletter. A credential that holds sending: read without it is refused with 403 insufficient_scope, param set to expand, and allowed_values listing what it may expand instead (newsletter). Unexpanded, article is a reference and needs nothing more. Accepted paths are article and newsletter.
Request
- Base URL: https://api.usecommune.com
- URL: https://api.usecommune.com/newsletters/{newsletter}/sends
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://usecommune.com/api/oauth/authorize, token URL https://usecommune.com/api/oauth/token, scopes: sending:read)
Query parameters
The pagination.next_cursor value from the previous page. Omit it to read the first page. A cursor is opaque, is only valid for the same operation with the same filters, and is not a durable identifier.
How many items to return in this page. This is a page size, not an offset. Fewer items than requested may come back and that does not mean the collection is exhausted, only an absent next_cursor does.
Comma-separated list of relationship paths to inline in the response. Unexpanded relationships are returned as a reference object carrying only id and object. Each operation documents the paths it accepts, and an unknown path answers 400. Nested paths use a dot, for example article.newsletter.
Comma-separated allow-list of top level properties to return on each object, so a client can trim a response it does not need in full. id and object are always returned. An unknown property name answers 400. Properties omitted by an operation, such as content on any article list, cannot be brought back with fields.
Only the runs that dispatched this article, by its id. The short_id is not accepted here: a filter takes the canonical identifier, and data[].article returns one.
Response
A page of sends, most recent first.
Example response
{
"pagination": {
"next_cursor": "Y3Vyc29yOjE3NTY0MjM2MDAwMDA6MDE5MmM4"
},
"data": [
{
"article": {
"object": "newsletter",
"id": "9a4c1c6e-0f2b-4f47-9d3f-6d1b1a2c3d4e"
},
"newsletter": {
"object": "newsletter",
"id": "9a4c1c6e-0f2b-4f47-9d3f-6d1b1a2c3d4e"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.