Exportar análise de dados de cartões do feed de notícias
get
/feed/data_series
Use esse ponto de extremidade para recuperar uma série diária de estatísticas de engajamento de um cartão ao longo do tempo.
note:
O feed de notícias será descontinuado. A Braze recomenda que os clientes que usam nossa ferramenta de feed de notícias migrem para o canal de envio de mensagens Content Cards - é mais flexível, personalizável e confiável. Confira o guia de migração para saber mais.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão feed.data_series
.
Limite de taxa
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
card_id |
Obrigatória | String | Consulte Identificador da API do cartão. O endereço card_id para um determinado cartão pode ser encontrado na página Chaves de API e na página de detalhes do cartão em seu dashboard, ou você pode usar o endpoint Exportar lista de cartões do feed de notícias. |
length |
Obrigatória | Inteiro | Número máximo de unidades (dias ou horas) antes de ending_at para incluir na série retornada. Deve estar entre 1 e 100 (inclusive). |
unit |
Opcional | String | Unidade de tempo entre os pontos de dados. Pode ser day ou hour , o padrão é day . |
ending_at |
Opcional | Datetime (ISO-8601 string) |
Data em que a série de dados deve terminar. O padrão é a hora da solicitação. |
Exemplo de solicitação
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'
Resposta
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) 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:
Para obter ajuda com exportações CSV e API, visite Solução de problemas de exportação.
New Stuff!