セグメント分析をエクスポート
get
/segments/data_series
このエンドポイントを使用して、セグメントの推定サイズの日次系列を経時的に取得します。
前提条件
このエンドポイントを使用するには、segments.data_series
権限のある API キーが必要です。
レート制限
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
リクエストパラメーター
パラメーター | 必須 | データ型 | 説明 |
---|---|---|---|
segment_id |
必須 | 文字列 | セグメント API 識別子を参照してください。segment_id 特定のセグメントのは、Braze アカウントの API キーページにあります。また、セグメントリストのエクスポートエンドポイントを使用することもできます。 |
length |
必須 | 整数 | 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
},
...
]
}
tip:
CSV と API のエクスポートに関するヘルプは、「エクスポートのトラブルシューティング」を参照してください。