CUcustomer
Automations

Get automation message metadata

Changed on

Returns information about the deliveries (instances of messages sent to individual people) sent from an automation. Provide query parameters to refine the metrics you want to return. Use the 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 the most recent 6 months of messages. 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/campaigns/{campaign_id}/messages

Request

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

Response

Returns an array of messages. Each object represents a different message in your automation.

Example response

{
  "messages": [
    {
      "id": "ag1q6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=",
      "deduplicate_id": "ag1q6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=:1619137768",
      "msg_template_id": 43,
      "action_id": 215,
      "parent_action_id": null,
      "customer_id": null,
      "recipient": "person@example.com",
      "subject": "Did you get that thing I sent you?",
      "metrics": {
        "delivered": 1619137768,
        "sent": 1619137768
      },
      "created": 1619137767,
      "failure_message": null,
      "newsletter_id": null,
      "content_id": null,
      "campaign_id": 23,
      "broadcast_id": null,
      "trigger_event_id": null,
      "type": "email",
      "forgotten": false
    }
  ]
}

Changes