News Feed card analytics endpoint
get
/feed/data_series
This endpoint allows you to retrieve a daily series of engagement stats for a card over time.
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 in the Developer Console page and on the card details page within your dashboard, or you can use the News Feed 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
1
2
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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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) point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"clicks" : (int) ,
"impressions" : (int),
"unique_clicks" : (int),
"unique_impressions" : (int)
},
...
]
}
tip:
For help with CSV and API exports, visit Export troubleshooting.