Skip to content

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

get

/segments/list

このエンドポイントを使用してセグメントのリストをエクスポートします。各セグメントには、名前、セグメント API 識別子、分析トラッキングが有効になっているかどうかが含まれます。

セグメントは、作成時刻順に並べられた 100 個のグループで返されます (デフォルトでは古いものから新しいものへ)。アーカイブされたセグメントは含まれません。

See me in Postman

前提条件

このエンドポイント を 使用するには、 segments.list 許可。

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

リクエストパラメータ

パラメータ 必須 データ型 説明
page オプション 整数 返されるセグメントのページ。デフォルトは 0 (最大 100 の最初のセットを返します)。
sort_direction オプション 文字列 - 作成日時を新しいものから古いものの順に並べ替える: 値を渡す 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 でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!