Detalles del segmento de exportación
get
/segments/details
Utiliza este punto final para recuperar información relevante sobre un segmento, que puede identificarse mediante la dirección
segment_id
.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso segments.details
.
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. |
Ejemplo de solicitud
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/segments/details?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,
"created_at" : (string) the date created as ISO 8601 date,
"updated_at" : (string) the date last updated as ISO 8601 date,
"name" : (string) the segment name,
"description" : (string) a human-readable description of filters,
"text_description" : (string) the segment description,
"tags" : (array) the tag names associated with the segment formatted as strings,
"teams" : (array) the names of the Teams associated with the campaign
}
tip:
Para obtener ayuda con las exportaciones CSV y API, visita Solución de problemas de exportación.
New Stuff!