Detalhes do segmento de exportação
get
/segments/details
Use esse endpoint para recuperar informações relevantes sobre um segmento, que pode ser identificado pelo endereço
segment_id
.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão segments.details
.
Limite de taxa
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
segment_id |
Obrigatória | String | Consulte Identificador da API de segmento. O endereço segment_id para um determinado segmento pode ser encontrado na página Chaves de API em sua conta Braze ou você pode usar o endpoint Exportar lista de segmentos. |
Exemplo de solicitação
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'
Resposta
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 obter ajuda com exportações de CSV e API, acesse Resolução de problemas de exportação.
New Stuff!