Exportar datos de ingresos por tiempo
get
/purchases/revenue_series
Utilice este punto final para devolver el dinero total gastado en su aplicación durante un intervalo de tiempo.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso purchases.revenue_series
.
Límite de velocidad
Aplicamos un límite de velocidad compartido de 1.000 peticiones por hora a este punto final. Este límite de velocidad se comparte con los puntos finales /custom_attributes
, /events
, y /events/list
, como se documenta en Límites de velocidad de la API.
Parámetros de la solicitud
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
ending_at |
Opcional | Fecha y hora (cadena ISO-8601) | Fecha en la que debe finalizar la exportación de datos. De forma predeterminada, la hora de la solicitud. |
length |
Obligatoria | Entero | Número máximo de días antes de ending_at a incluir en la serie devuelta. Debe estar comprendido entre 1 y 100 (ambos inclusive). |
unit |
Opcional | Cadena | Unidad de tiempo entre puntos de datos. Puede ser día u hora, por defecto día. |
app_id |
Opcional | Cadena | Identificador de API de la aplicación recuperado de la página Claves de API. Si se excluye, se mostrarán los resultados de todas las aplicaciones de un espacio de trabajo. |
product |
Opcional | Cadena | Nombre del producto por el que filtrar la respuesta. Si se excluye, se mostrarán los resultados de todas las aplicaciones. |
Ejemplo de solicitud
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/purchases/revenue_series?length=100' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Respuesta
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 obtener ayuda con las exportaciones CSV y API, visita Solución de problemas de exportación.
New Stuff!