Análisis de segmentos de exportación
get
/segments/data_series
Utilice este punto final para recuperar una serie diaria del tamaño estimado de un segmento a lo largo del tiempo.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso segments.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 |
---|---|---|---|
segment_id |
Obligatoria | Cadena | Ver Identificador API de segmento. La dirección segment_id para un segmento determinado se puede encontrar en la página Claves de API dentro de su cuenta Braze o puede utilizar el punto final Exportar lista de segmentos. |
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). |
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. |
Ejemplo de solicitud
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/segments/data_series?segment_id={{segment_identifier}}&length=14&ending_at=2018-06-27T23:59:59-5:00' \
--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,
"size" : (int) the size of the segment on that date
},
...
]
}
tip:
Para obtener ayuda con las exportaciones CSV y API, visita Solución de problemas de exportación.
New Stuff!