Skip to content

Exporter les sessions de l’application par période

get

/sessions/data_series

Utilisez cet endpoint pour récupérer une série du nombre de sessions de votre application sur une période donnée.

See me in Postman

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation sessions.data_series.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Paramètres de requête

Paramètre Requis Type de données Description
length Requis Entier Nombre maximum d’unités (jours ou heures) avant ending_at à inclure dans la série renvoyée. Doit être compris entre 1 et 100 (inclus).
unit Facultatif Chaîne de caractères Unité de temps entre les points de données. Peut être day ou hour, valeur par défaut day.
ending_at Facultatif Datetime
(chaîne ISO-8601)		 Date à laquelle la série de données doit se terminer. Par défaut, l’heure de la requête.
app_id Facultatif Chaîne de caractères Identifiant API de l’application récupéré à partir de la page Clés API pour limiter l’analyse à une application spécifique.
segment_id Facultatif Chaîne de caractères Voir Identifiant API de segment. ID du segment avec analyse activée pour lequel les sessions doivent être renvoyées.

Exemple de requête

1
2

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'

Réponse

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