Skip to content

Exportar detalles del segmento

get

/segments/details

Utiliza este endpoint para recuperar información relevante sobre un segmento, que puede identificarse mediante el segment_id.

See me in Postman

Requisitos previos

Para utilizar este endpoint, 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 endpoint, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
segment_id Obligatorio Cadena Ver identificador de API del segmento.

El segment_id de un segmento determinado se puede encontrar en la página Claves de API dentro de tu cuenta de Braze, o puedes utilizar el endpoint 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

{
      "message": (string) returns 'success' when the request completes 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
}
New Stuff!