このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、 GitHubでイシューを作成してください.
Segment分析のエクスポート
get
/segments/data_series
このエンドポイントを使用して、Segmentの推定サイズの日次データを時系列で取得します。
前提条件
このエンドポイントを使用するには、segments.data_series 権限を持つAPIキーが必要です。
レート制限
APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限(1時間あたり250,000リクエスト)が適用されます。
リクエストパラメーター
| パラメーター | 必須 | データタイプ | 説明 |
|---|---|---|---|
segment_id |
必須 | 文字列 | セグメントAPI識別子を参照してください。 特定のSegmentの segment_idは、BrazeアカウントのAPIキーページで確認できます。また、Segment一覧エクスポートエンドポイントを使用することもできます。 |
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
{
"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
},
...
]
}
ヒント:
CSVおよびAPIエクスポートに関するヘルプについては、エクスポートのトラブルシューティングを参照してください。
New Stuff!