Exportar análises de dados de eventos personalizados
get
/events/data_series
Use esse endpoint para recuperar uma série do número de ocorrências de um evento personalizado em seu app durante um período de tempo designado.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão events.data_series
.
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 |
---|---|---|---|
event |
Obrigatória | String | O nome do evento personalizado para o qual retornar a análise de dados. |
length |
Obrigatória | Inteiro | Número máximo de unidades (dias ou horas) antes de ending_at para incluir na série retornada. Deve estar entre 1 e 100 (inclusive). |
unit |
Opcional | String | Unidade de tempo entre os pontos de dados. Pode ser day ou hour , o padrão é day . |
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. |
app_id |
Opcional | String | Identificador da API do aplicativo recuperado da página Chaves de API para limitar a análise de dados a um aplicativo específico. |
segment_id |
Opcional | String | Consulte Identificador da API de segmento. ID do segmento que indica o segmento com análise de dados ativada para o qual a análise de eventos deve ser retornada. |
Exemplo de solicitação
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/events/data_series?event=event_name&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05:00&app_id={{app_identifier}}&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,
"data" : [
{
"time" : (string) the point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"count" : (int) the number of occurrences of provided custom event
},
...
]
}
Códigos de resposta a erros fatais
Para obter os códigos de status e as mensagens de erro associadas que serão retornadas se sua solicitação encontrar um erro fatal, consulte Erros e respostas fatais.
tip:
Para obter ajuda com exportações de CSV e API, acesse Resolução de problemas de exportação.
New Stuff!