Skip to content
WhiteBeard

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.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
channel_id
required
string

Filter by channel ID (comma-separated for multiple)

Query Parameters

Section titled “Query Parameters”
page_number
required
integer
limit
required
integer
>= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

List of newsletter posts

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

API representation of a social post

object
id

Post ID

integer format: int64
channelId

Channel ID

integer format: int64
objectSignature

Object signature

string
contents

Post contents

string
image

Post image

string format: uri
date

Publish date

string format: date-time
status

Post status

string
serviceResponse

Response from external service (admin only)

object
analytics
Channel Post Statistics

Analytics data related to the post

object
date

Publish date of this post in local datetime (not RFC 3339)

string
timestamp

Timestamp of this data snapshot in RFC 3339 format

string format: date-time
total

Total recipients for this campaign

integer
delivered

Number of successfully sent emails (at delivery)

integer
failed

Number of failed emails at delivery time (hard bounce)

integer
open

Number of unique opens

integer
open_human

Number of opens determined to be by humans

integer
open_automated

Number of opens determined to be by automated systems

integer
open_mpp

Number of opens from Apple MPP proxies

integer
open_unknown

Number of opens from unknown sources

integer
open_unique_human

Number of unique opens determined to be by humans

integer
open_unique_automated

Number of unique opens determined to be by automated systems

integer
open_unique_mpp

Number of unique opens from Apple MPP proxies

integer
open_unique_unknown

Number of unique opens from unknown sources

integer
clicks

Number of real link clicks excluding bots

integer
clicks_automated_unique

Number of link clicks determined to be by automated systems

integer
unsub

Number of unsubscribed recipients from this email

integer
reopens

Number of opens and reopens

integer
metric

Total calculated reach of the post

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
data

Country code to count mapping

object
key
additional properties
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.

object
key
additional properties
object
date
string
timestamp
string format: date-time
total
integer
delivered
integer
failed
integer
open
integer
open_human
integer
open_automated
integer
open_mpp
integer
open_unknown
integer
clicks
integer
clicks_automated_unique
integer
unsub
integer
reopens
integer
metric
integer
reasons
object
graphs
Array
>= 2 items <= 2 items
One of:
Opens By Country

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

object
data

Country code to count mapping

object
key
additional properties
integer
clicks_details

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

Array<object>
object
url
string format: uri
count
string
count_automated
string
count_unknown
string
unique_count
string
unique_count_automated
string
unique_count_unknown
string

Example 

{
  "data": [
    {
      "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
          }
        }
      }
    }
  ]
}