사용자 지정 이벤트 분석 내보내기
get
/events/data_series
이 엔드포인트를 사용하여 지정된 기간 동안 앱에서 커스텀 이벤트가 발생한 일련의 횟수를 검색할 수 있습니다.
필수 구성 요소
이 엔드포인트를 사용하려면 events.data_series
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
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
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,
"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
},
...
]
}
치명적인 오류 응답 코드
요청에 심각한 오류가 발생할 경우 반환되는 상태 코드 및 관련 오류 메시지는 심각한 오류 및 응답을 참조하세요.
tip:
CSV 및 API 내보내기에 대한 도움말은 내보내기 문제 해결을 참조하세요.
New Stuff!