Exportar dados de receita por tempo
get
/purchases/revenue_series
Use esse endpoint para retornar o total de dinheiro gasto em seu app em um intervalo de tempo.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão purchases.revenue_series
.
Limite de taxa
For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the /custom_attributes
, /events
, and /events/list
endpoints, as documented in API rate limits.
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
ending_at |
Opcional | Datetime (ISO-8601 string) | Data em que a exportação de dados deve terminar. Padrões para o momento da solicitação. |
length |
Obrigatória | Inteiro | Número máximo de dias 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 dia ou hora; o padrão é dia. |
app_id |
Opcional | String | Identificador da API do app recuperado da página Chaves de API. Se excluído, serão retornados os resultados de todos os apps em um espaço de trabalho. |
product |
Opcional | String | Nome do produto para filtrar a resposta por. Se excluído, os resultados de todos os apps serão retornados. |
Exemplo de solicitação
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/purchases/revenue_series?length=100' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Resposta
1
2
3
4
5
6
7
8
9
10
11
12
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 date as ISO 8601 date,
"revenue" : (int) amount of revenue for the time period
},
...
]
}
tip:
Para obter ajuda com exportações de CSV e API, acesse Resolução de problemas de exportação.
New Stuff!