Skip to content

セグメント詳細をエクスポート

get

/segments/details

このエンドポイントを使用して、で識別できるセグメントの関連情報を取得しますsegment_id。

See me in Postman

前提条件

このエンドポイントを使用するには、segments.details権限のある 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 キーページにあります。また、セグメントリストのエクスポートエンドポイントを使用することもできます。

リクエスト例

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/segments/details?segment_id={{segment_identifier}}' \
--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,
      "created_at" : (string) the date created as ISO 8601 date,
      "updated_at" : (string) the date last updated as ISO 8601 date,
      "name" : (string) the segment name,
      "description" : (string) a human-readable description of filters,
      "text_description" : (string) the segment description, 
      "tags" : (array) the tag names associated with the segment formatted as strings,
      "teams" : (array) the names of the Teams associated with the campaign
}
  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!