Exportar análise de dados do segmento

Use esse endpoint para recuperar uma série diária do tamanho estimado de um segmento ao longo do tempo.

Se você precisar do tamanho exato de um segmento, exporte seus usuários com o endpoint /users/export/segment e conte os perfis exportados.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão segments.data_series.

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

Parâmetros de solicitação

Exemplo de solicitação

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'

Resposta

1
2
3
4
5
6
7
8
9
10
{
    "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
        },
        ...
    ]
}