Skip to content

사용자 지정 이벤트 분석 내보내기

get

/events/data_series

이 엔드포인트를 사용하여 지정된 기간 동안 앱에서 커스텀 이벤트가 발생한 횟수의 시계열 데이터를 조회할 수 있습니다.

필수 조건

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

사용량 제한

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

요청 매개변수

매개변수 필수 데이터 유형 설명
event 필수 문자열 분석을 반환할 커스텀 이벤트의 이름입니다.
length 필수 정수 ending_at 이전에 반환된 시리즈에 포함할 최대 단위(일 또는 시간) 수입니다. 1에서 100 사이여야 합니다(포함).
unit 선택 사항 문자열 데이터 포인트 간의 시간 단위입니다. day 또는 hour일 수 있으며 기본값은 day입니다.
ending_at 선택 사항 날짜/시간
(ISO-8601 문자열)
데이터 시리즈가 종료되어야 하는 날짜입니다. 요청 시점으로 기본 설정됩니다.
app_id 선택 사항 문자열 API 키 페이지에서 가져온 앱 API 식별자로, 특정 앱으로 분석을 제한할 수 있습니다.
segment_id 선택 사항 문자열 세그먼트 API 식별자를 참조하세요. 이벤트 분석을 반환할 분석 활성화 세그먼트를 나타내는 세그먼트 ID입니다.

요청 예시

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/events/data_series?event=event_name&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05:00&app_id={{app_identifier}}&segment_id={{segment_identifier}}' \
--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 point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
            "count" : (int) the number of occurrences of provided custom event
        },
        ...
    ]
}

심각한 오류 응답 코드

요청에 심각한 오류가 발생할 경우 반환되는 상태 코드 및 관련 오류 메시지는 심각한 오류 및 응답을 참조하세요.

New Stuff!