Skip to content

List newsletter posts

GET
/cms/channel/{channel_id}/post
curl --request GET \
--url 'https://api.example.com/cms/channel/example/post?page_number=1&limit=1' \
--header 'API-Key: <API-Key>'

Returns a paginated list of published newsletter posts for a channel or a list of channels.

channel_id
required
string

Filter by channel ID (comma-separated for multiple)

page_number
required
integer
limit
required
integer
>= 1 <= 100

List of newsletter posts

Media typeapplication/json
object
data
Array<object>
Channel Post

API representation of a social post

object
id

Post ID (DB integer serialized as a string)

string
channelId

Channel ID (DB integer serialized as a string)

string
objectSignature

Object signature

string
contents

Post contents

string
image

Post image

string format: uri
date

Publish date (MySQL datetime)

string
status

Post status

string
serviceResponse

Response from external service (admin only); its shape depends on the service, e.g. a list of mailer progress reports

nullable
One of:
object
analytics
Channel Post Statistics

Analytics data related to the post

object
date

Publish date of this post in local datetime (not RFC 3339). Counters are stored as sent by the mailer, so older snapshots may hold them as numeric strings

string
timestamp

Timestamp of this data snapshot in RFC 3339 format

string format: date-time
total

Total recipients for this campaign

One of:
integer
delivered

Number of successfully sent emails (at delivery)

One of:
integer
failed

Number of failed emails at delivery time (hard bounce)

One of:
integer
open

Number of unique opens

One of:
integer
open_human

Number of opens determined to be by humans

One of:
integer
open_automated

Number of opens determined to be by automated systems

One of:
integer
open_mpp

Number of opens from Apple MPP proxies

One of:
integer
open_unknown

Number of opens from unknown sources

One of:
integer
open_unique_human

Number of unique opens determined to be by humans

One of:
integer
open_unique_automated

Number of unique opens determined to be by automated systems

One of:
integer
open_unique_mpp

Number of unique opens from Apple MPP proxies

One of:
integer
open_unique_unknown

Number of unique opens from unknown sources

One of:
integer
clicks

Number of real link clicks excluding bots

One of:
integer
clicks_automated_unique

Number of link clicks determined to be by automated systems

One of:
integer
unsub

Number of unsubscribed recipients from this email

One of:
integer
reopens

Number of opens and reopens

One of:
integer
metric

Total calculated reach of the post

One of:
integer
reasons

Counts per failure reason

object
graphs

Graphed data. Graph 0 opens by country, Graph 1 opens by hour (0–23)

Array
>= 2 items <= 2 items
One of:
Opens By Country

Opens by country (ISO 3166-1 alpha-2)

object
key
additional properties
One of:
integer
clicks_details

List of URLs clicked by humans, with their count and unique count

Array<object>
object
url
string format: uri
link_id

Identifier for this link’s position in the email template, used to distinguish multiple links that point to the same URL. Null for links tracked before this field existed.

string
nullable
count
string
count_automated
string
count_unknown
string
unique_count
string
unique_count_automated
string
unique_count_unknown
string
history

Historical snapshots taken at specific minutes after publish (e.g., 15, 30, 60). Each value is a ChannelPostStatistics object without the history key. An empty JSON array when there are no snapshots yet.

One of:
Array
0

Example

{
"data": [
{
"id": "7486",
"channelId": "3",
"date": "2026-01-08 14:43:19",
"analytics": {
"date": "2025-08-17 12:58:49",
"timestamp": "2025-08-17T13:17:44+03:00",
"reasons": {
"Complaint": 5,
"Bounce": 3
},
"graphs": [
{
"NL": 10,
"US": 20,
"CA": "15"
}
],
"clicks_details": [
{
"url": "https://www.whitebeard.nl",
"link_id": "wb-link-3",
"count": "1",
"count_automated": "1",
"count_unknown": "1",
"unique_count": "1",
"unique_count_automated": "1",
"unique_count_unknown": "1"
}
],
"history": {
"15": {
"total": 100,
"delivered": 95,
"open": 10
},
"60": {
"total": 100,
"delivered": 95,
"open": 25
},
"1440": {
"total": 100,
"delivered": 95,
"open": 45
}
}
}
}
]
}