Newsletter Metrics

Get click metrics for links in one-time send variants

Changed on

Returns link click metrics for an individual one-time send (referred to as a "newsletter" in our APIs) variant—an individual language in a multi-language one-time send or a message in an A/B test. Unless you specify otherwise, the response contains data for the maximum period by days (45 days).

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/links

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics/links
  • 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

{
  "links": [
    {
      "link": {
        "id": 1234,
        "href": "https://docs.customer.io"
      },
      "metric": {
        "series": {
          "clicked": [
            1,
            3,
            5,
            7
          ],
          "human_clicked": [
            1,
            2,
            3,
            4
          ],
          "machine_clicked": [
            0,
            1,
            1,
            2
          ]
        }
      }
    }
  ]
}

Changes