Skip to content

輸出セグメント分析

get

/segments/data_series

このエンドポイントを使用して、時間の経過に伴うセグメントの推定サイズの日次情報を取得します。

See me in Postman

前提条件

このエンドポイントを使用するには、segments.data_series 権限を持つ API キーが必要です。

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

リクエストパラメーター

パラメーター required データ型 説明
segment_id 必須 string 「セグメント API 識別子」を参照してください。

指定したセグメントの segment_id は、Braze アカウント内の API キーページで確認するか、「セグメントリストのエクスポート」エンドポイントを使用できます。
length required 整数 返されるシリーズに ending_at が含まれるまでの最大日数。1以上100以下でなければなりません。
ending_at オプション 日時
(ISO-8601文字列)		 データシリーズが終了する日付。デフォルトはリクエストの時刻です。

リクエスト例

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'

応答

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
        },
        ...
    ]
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!