Skip to content

セグメントリストをエクスポートする

get

/segments/list

このエンドポイントを使用して、名前、セグメント API 識別子、分析の追跡が有効かどうかがそれぞれに含まれているセグメントのリストをエクスポートします。

セグメントは100のグループに分けられ、作成日順にソートされて返される（デフォルトでは古いものから新しいものへ）。アーカイブされたセグメントは含まれません。

See me in Postman

前提条件

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

レート制限

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

リクエストパラメーター

パラメーター required データ型 説明
page オプション 整数 返すセグメントのページ。デフォルトは0（最大100の最初のセットを返す）。
sort_direction オプション string - 作成時刻を新しいものから古いものへとソートする: 値 desc を渡す。
- 作成時刻を古いものから新しいものへとソートする: 値 asc を渡す。

sort_direction が含まれていない場合、デフォルトの順序は古いものから新しいものとなる。

リクエスト例

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/segments/list?page=1&sort_direction=desc' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

1
2
3
4
5
6
7
8
9
10
11
12
13
14

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "segments" : [
        {
            "id" : (string) the Segment API identifier,
            "name" : (string) segment name,
            "analytics_tracking_enabled" : (boolean) whether the segment has analytics tracking enabled,
            "tags" : (array) the tag names associated with the segment formatted as strings
        },
        ...
    ]
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!