Customer.io
v1.0.0
OpenAPI 3.1.0

Report metrics

US region

Client Libraries
Shell Curl

Report metrics

​

This endpoint helps you report metrics from channels that aren't native to Customer.io or don't rely on our SDKs. When we deliver a message, we include a CIO-Delivery-ID header. This is the delivery_id in the payload. You can use it as a UTL and you can pass it as a UTM parameter in links, etc to track metrics when people click, convert, etc.

Body
application/json

    • The base properties shared across multiple metric types.

      • delivery_id
        Type: string
        required

        The CIO-Delivery-ID from the notification that you want to associate the event with.

      • metric
        Type: stringenum
        required

        The email metric you want to report back to Customer.io.

        values
        • bounced
        • clicked
        • converted
        • deferred
        • delivered
        • dropped
        • opened
        • spammed
      • href
        Type: string

        For clicked metrics, this is the link the recipient clicked.

      • reason
        Type: string

        For metrics indicating a failure (like bounced), this field provides the reason for the failure.

      • recipient
        Type: string

        The email of the person who received the message.

      • timestamp
        Type: integerFormat: unix timestamp

        The unix timestamp when the event occurred.

Responses
  • 200

    The request was received.

Request Example for post/api/v1/metrics
curl https://track.customer.io/api/v1/metrics \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "delivery_id": "RPILAgUBcRhIBqSfeiIwdIYJKxTY",
  "timestamp": 1613063089,
  "metric": "bounced",
  "recipient": "",
  "reason": "",
  "href": ""
}'
No Body

The request was received.