Newsletter Metrics

Get metrics for a test or translation variant of a one-time send

Changed on

Returns a metrics for an individual one-time send (referred to as a "newsletter" in our APIs) variant—either an individual language in a multi-language one-time send or a message in an A/B test. This endpoint returns metrics both in total and in steps (days, weeks, etc) over a period of time. Stepped series metrics are arranged from oldest to newest (i.e. the 0-index for any result is the oldest period/step).

You cannot request fewer than 2 steps of any period (2 hours, 2 days, 2 weeks, or 2 months). For instance, ?period=days&steps=1 means two days - the 48 hours before the API request was made. ?period=days&steps=0 returns the same as the maximum of the period - ?period=days&steps=45. See the steps parameter below for the maximum count of each period.

get/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics

Request

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

Response

Returns one-time send variant metrics by series (with increments are based on the period and step in your request) for the one-time send.

Example response

{
  "metric": {
    "type": "email"
  }
}

Changes