Skip to content

세그먼트 분석 내보내기

get

/segments/data_series

이 엔드포인트를 사용하여 시간 경과에 따른 세그먼트의 예상 크기에 대한 일별 시계열을 조회합니다.

세그먼트의 정확한 크기가 필요한 경우 /users/export/segment 엔드포인트를 사용하여 사용자를 내보내고 내보낸 프로필 수를 집계하세요.

필수 조건

이 엔드포인트를 사용하려면 segments.data_series 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트에는 API 사용량 제한 설명서에 명시된 대로 기본 Braze 사용량 제한인 시간당 250,000건의 요청이 적용됩니다.

요청 매개변수

매개변수 필수 데이터 유형 설명
segment_id 필수 문자열 세그먼트 API 식별자를 참조하세요.

지정된 세그먼트의 segment_id는 Braze 계정 내 API 키 페이지에서 찾을 수 있으며, 세그먼트 목록 내보내기 엔드포인트를 사용할 수도 있습니다.
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
        },
        ...
    ]
}
New Stuff!