Exportar sessão do app por hora

get

/sessions/data_series

Use esse endpoint para recuperar uma série do número de sessões do seu app em um período de tempo designado.

See me in Postman

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão sessions.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

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 as sessões devem ser retornadas.

Exemplo de solicitação

curl --location -g --request GET 'https://rest.iad-01.braze.com/sessions/data_series?length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}&segment_id={{segment_identifier}}' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Resposta

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) point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
            "sessions" : (int)
        },
        ...
    ]
}

tip:

Para obter ajuda com exportações de CSV e API, acesse Resolução de problemas de exportação.

Editar esta página no GitHub

QUÃO ÚTIL FOI ESTA PÁGINA?

Editar esta página no GitHub

New Stuff!