Análise de dados do segmento de exportação
get
/segments/data_series
Use esse ponto de extremidade para recuperar uma série diária do tamanho estimado de um segmento ao longo do tempo.
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 frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.
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_idpara 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. | 
| length | Obrigatória | Inteiro | Número máximo de dias antes de ending_atpara incluir na série retornada. Deve estar entre 1 e 100 (inclusive). | 
| ending_at | Opcional | Datetime (ISO-8601 string) | Data em que a série de dados deve terminar. O padrão é a hora da 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
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 obter ajuda com exportações de CSV e API, acesse Resolução de problemas de exportação.
New Stuff!
 
  Editar esta página no GitHub
   Editar esta página no GitHub