Export News Feed card analytics

get

/feed/data_series

Use this endpoint to retrieve a daily series of engagement stats for a card over time.

important:

News Feed is being deprecated. We recommend migrating to our Content Cards messaging channel instead—it’s more flexible, customizable, and reliable. To get started, check out Migrating from News Feed.

See me in Postman

Prerequisites

To use this endpoint, you’ll need an API key with the feed.data_series permission.

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Request parameters

Parameter Required Data Type Description

card_id Required String See Card API identifier.

The card_id for a given card can be found on the API Keys page and on the card details page within your dashboard, or you can use the Export News Feed cards list endpoint.

length Required Integer Maximum number of units (days or hours) before ending_at to include in the returned series. Must be between 1 and 100 (inclusive).

unit Optional String Unit of time between data points. Can be day or hour, defaults to day.

ending_at Optional Datetime
(ISO-8601 string) Date on which the data series should end. Defaults to time of the request.

Example request

curl --location -g --request GET 'https://rest.iad-01.braze.com/feed/data_series?card_id={{card_identifier}}&length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "data" : [
        {
            "time" : (string) the point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
            "clicks" : (int) the number of clicks,
            "impressions" : (int) the number of impressions,
            "unique_clicks" : (int) the number of unique clicks,
            "unique_impressions" : (int) the number of unique impressions
        },
        ...
    ]
}

tip:

For help with CSV and API exports, visit Export troubleshooting.

Edit this page on GitHub

HOW HELPFUL WAS THIS PAGE?

Edit this page on GitHub

New Stuff!