CUcustomer
Newsletter Metrics

Get delivery data for a one-time send

Changed on

Returns information about the "deliveries" (rendered messages) sent to your recipients for a specific one-time send (referred to as a "newsletter" in our APIs).

Provide query parameters to refine the metrics you want to return. Use start_ts and end_ts to find messages within a time range. If your request doesn't include start_ts and end_ts parameters, we'll return up to 6 months of results beginning with the first delivery generated from the one-time send. If your start_ts and end_ts range is more than 12 months, we'll return 12 months of data from the most recent timestamp in your request.

Timestamps reflect when deliveries were created in our system, not when they were actually sent to recipients. There may be a delay between creation and sending.

get/v1/newsletters/{newsletter_id}/messages

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/newsletters/{newsletter_id}/messages
  • Auth
    HTTP bearer

Response

Returns an array of messages. Each object represents a different delivery to a recipient.

Example response

{
  "messages": [
    {
      "id": "dgOq6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=",
      "deduplicate_id": "15:1492548073",
      "customer_id": "42",
      "customer_identifiers": {
        "email": "test@example.com",
        "cio_id": "a3000001"
      },
      "recipient": "{{customer.email}}",
      "subject": "Did you get that thing I sent you?",
      "created": 1552341937,
      "campaign_id": 5,
      "action_id": 96,
      "parent_action_id": 1,
      "newsletter_id": 10,
      "content_id": 1,
      "broadcast_id": 2,
      "trigger_event_id": "21E4C3CT6YDC7Y4N7FE1GWWABC",
      "tracked_responses": {
        "cool-button": {
          "id": 1,
          "ts": 1715769600
        },
        "cool-button-2": {
          "id": 2,
          "ts": 1715769600
        }
      },
      "type": "email"
    }
  ]
}

Changes