9

Journeys Message Metrics Source

How it works

Customer.io automatically captures events relating to message activity—the messages you send, whether or not people open them, when people click them, and so on. So when you look at your integrations, you’ll see Customer.io (Workspaces) as a data source that you can connect to other services.

Treating incoming metrics as a source lets you send data to destinations that help you aggregate and analyze audience data, so you follow and chart how your audience reacts to different message channels in your marketing stack. And understanding our payload format helps you accurately map metrics from Customer.io to other platforms you might use to analyze your audience data.

What metrics do we send out of Customer.io?

See our semantic events specification for a complete list of the events, and properties, we send out of Customer.io.

Customer.io captures and sends the following semantic events downstream to your connected destinations:

Metric Events

Customer.io metrics are sent as semantic track events—they look like any event you’d send to Customer.io using the track method, but they have a specific event name that combines the channel and metric—like Email Opened or Push Sent.

The properties object contains information about the customer, the message (delivery_id), the campaign, broadcast, or transactional ID the message originated from, and so on.

Event Format

All metric events follow this structure:

Available Events

We send track events for all message lifecycle metrics across different channels:

• Email: Email Drafted, Email Attempted, Email Sent, Email Delivered, Email Opened, Email Link Clicked, Email Converted, Email Unsubscribed, Email Bounced, Email Suppressed, Email Marked as Spam, Email Failed
• Push: Push Drafted, Push Attempted, Push Sent, Push Delivered, Push Opened, Push Link Clicked, Push Converted, Push Bounced, Push Suppressed, Push Failed
• SMS: SMS Drafted, SMS Attempted, SMS Sent, SMS Delivered, SMS Link Clicked, SMS Converted, SMS Bounced, SMS Failed
• In-App: In-App Drafted, In-App Attempted, In-App Sent, In-App Opened, In-App Clicked, In-App Converted, In-App Failed
• Webhook: Webhook Drafted, Webhook Attempted, Webhook Sent, Webhook Link Clicked, Webhook Converted, Webhook Failed
• Slack: Slack Drafted, Slack Attempted, Slack Sent, Slack Link Clicked, Slack Failed
• Subscription: Subscribed, Unsubscribed, Subscription Preferences Changed

Common Properties

Most metric events include these common properties in the properties object:

Example: Email Opened Event

{
  "type": "track",
  "event": "Email Opened",
  "userId": "12345",
  "messageId": "01H8F21G9KK14JKX233RDFJCNM",
  "timestamp": "2023-08-22T16:42:55.003Z",
  "sentAt": "2023-08-22T16:42:57.739Z",
  "context": {
    "traits": {
      "email": "cool.person@example.com"
    }
  },
  "properties": {
    "customer_id": "12345",
    "delivery_id": "RKK4AwUAAYoeIC5PHMYd6-vTAYhWkQ==",
    "recipient": "cool.person@example.com",
    "subject": "Password reset request",
    "transactional_message_id": 8,
    "userId": "12345"
  },
  "receivedAt": "2023-08-22T16:42:57.742Z",
  "originalTimestamp": "2023-08-22T16:42:55.000Z"
}

Example: Push Sent Event

Push events include a recipients array that contains information about each device the push was sent to:

{
  "type": "track",
  "event": "Push Sent",
  "userId": "12345",
  "messageId": "01H8F21G9KK14JKX233RDFJCNM",
  "timestamp": "2023-08-22T16:42:55.003Z",
  "sentAt": "2023-08-22T16:42:57.739Z",
  "context": {
    "traits": {}
  },
  "properties": {
    "customer_id": "12345",
    "delivery_id": "dgS_ugcCBYUGhAYBlNIe87ANFfGw2QrqUUY1",
    "content_id": 1,
    "newsletter_id": 1,
    "recipients": [
      {
        "device_id": "123",
        "device_platform": "android"
      }
    ],
    "userId": "12345"
  },
  "receivedAt": "2023-08-22T16:42:57.742Z",
  "originalTimestamp": "2023-08-22T16:42:55.000Z"
}