세그먼트 목록 내보내기
get
/segments/list
이 엔드포인트를 사용하여 세그먼트 목록을 내보내면 각 세그먼트의 이름, 세그먼트 API 식별자, 분석 추적이 사용 설정되어 있는지 여부가 포함됩니다.
세그먼트는 생성 시간별로 정렬된 100개 그룹으로 반환됩니다(기본값으로 가장 오래된 것부터 가장 최근 것까지 정렬). 보관된 세그먼트는 포함되지 않습니다.
필수 구성 요소
이 엔드포인트를 사용하려면 segments.list
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
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
},
...
]
}
tip:
CSV 및 API 내보내기에 대한 도움말은 내보내기 문제 해결을 참조하세요.
New Stuff!