Exportar análisis de eventos personalizados
get
/events/data_series
Utiliza este punto final para recuperar una serie del número de ocurrencias de un evento personalizado en tu aplicación durante un periodo de tiempo designado.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso events.data_series
.
Límite de velocidad
Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.
Parámetros de la solicitud
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
event |
Obligatoria | Cadena | El nombre del evento personalizado para el que devolver los análisis. |
length |
Obligatoria | Entero | Número máximo de unidades (días u horas) antes de ending_at a incluir en la serie devuelta. Debe estar entre 1 y 100 (ambos inclusive). |
unit |
Opcional | Cadena | Unidad de tiempo entre puntos de datos. Puede ser day o hour , de forma predeterminada, day . |
ending_at |
Opcional | Fecha y hora (cadena ISO-8601) |
Fecha en la que debe finalizar la serie de datos. De forma predeterminada, la hora de la solicitud. |
app_id |
Opcional | Cadena | Identificador de API de la aplicación recuperado de la página Claves de API para limitar el análisis a una aplicación concreta. |
segment_id |
Opcional | Cadena | Ver Identificador API de segmento. ID del segmento que indica el segmento habilitado para el análisis para el que debe devolverse el análisis de eventos. |
Ejemplo de solicitud
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/events/data_series?event=event_name&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05:00&app_id={{app_identifier}}&segment_id={{segment_identifier}}' \
--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 point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"count" : (int) the number of occurrences of provided custom event
},
...
]
}
Códigos de respuesta de error fatal
Para conocer los códigos de estado y los mensajes de error asociados que se devolverán si tu solicitud encuentra un error fatal, consulta Errores fatales y respuestas.
tip:
Para obtener ayuda con las exportaciones CSV y API, visita Solución de problemas de exportación.
New Stuff!