Broadcasts

Get broadcast action metrics

Changed on

Returns a list of metrics for an individual action both in total and in steps (days, weeks, etc) over a period of time. Stepped series metrics return from oldest to newest (i.e. the 0-index for any result is the oldest step/period).

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.

Multi-language messages

If the action is a multi-language message, you can retrieve metrics for a single language variant or all language variants. To retrieve metrics for a single language variant, pass the id of the action. To retrieve aggregate metrics and a breakdown for each language variant, pass the multi_language_branch_action_id, which is the same for each variant of a message. You can get both ids from the List broadcast actions endpoint.

If you pass the multi_language_branch_action_id, then the metric object shows the total across every variant. The language_variants object shows a breakdown for each language variant.

If you want to get the sum of all metrics across all of a broadcast's actions, you can use each action id of a multi-language message, like you would for other types of actions.

get/v1/broadcasts/{broadcast_id}/actions/{action_id}/metrics

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/broadcasts/{broadcast_id}/actions/{action_id}/metrics
  • Auth
    HTTP bearer

Response

Returns action metrics by series (with increments are based on the period and step in your request) for the broadcast. For a multi-language message, also returns a per-variant breakdown in language_variants.

language_variantsLanguageVariantMetrics

Metrics for each language variant of a multi-language message, keyed by the variant's action ID. Only returned when you request metrics for a multi-language branch action.

Changes