Skip to content

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.

See me in Postman

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão purchases.revenue_series.

Limite de taxa

Aplicamos um limite de taxa compartilhado de 1.000 solicitações por hora a esse endpoint. Esse limite de taxa é compartilhado com os endpoints /custom_attributes, /events e /events/list, conforme documentado em Limites de taxa da API.

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
ending_at Opcional Datetime (string ISO-8601) Data em que a exportação de dados deve terminar. O padrão é 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 de 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. 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

{
  "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
      },
    ...
  ]
}
New Stuff!