Skip to content

내보내기 엔드포인트

이 엔드포인트 모음을 사용하면 KPI, 앱 세션, 사용자, 세그먼트, Campaigns, Canvases에 대한 다양한 수준의 세부 정보에 액세스하고 내보낼 수 있습니다. 매개변수 및 요청 본문을 작성할 때 Braze 인스턴스, API 키, API 식별자를 알고 있어야 합니다.

필수 조건

시작하기 전에 다음 사항을 준비하세요.

요구 사항 설명
Braze REST API 키 호출하려는 엔드포인트에 적합한 내보내기 권한이 있는 REST API 키입니다. API 키는 특정 엔드포인트에 범위가 지정되며, 생성 후에는 권한을 변경할 수 없습니다. 자세한 내용은 REST API 키를 참조하세요.
관련 식별자 내보내려는 데이터의 식별자(예: Campaign ID, Segment ID, Canvas ID)입니다. Braze 대시보드에서 확인할 수 있습니다. 전체 목록은 API 식별자 유형을 참조하세요.
클라우드 스토리지 자격 증명(선택 사항) 대규모 데이터셋을 내보내는 경우, Amazon S3, Microsoft Azure Blob Storage, 또는 Google Cloud Storage 버킷을 연결하여 내보내기 파일을 스토리지에 직접 기록할 수 있습니다.

내보낼 수 있는 항목

다음 표는 내보내기 API를 통해 사용할 수 있는 데이터 카테고리를 요약합니다.

카테고리 포함 항목 API 참조
Campaigns 성과 분석, 캠페인 세부 정보, 캠페인 목록, 발송 분석 캠페인 엔드포인트
Canvases 데이터 시리즈 분석, 분석 요약, Canvas 세부 정보, Canvas 목록 캔버스 엔드포인트
Segments 세그먼트 목록, 세그먼트 분석, 세그먼트 세부 정보 세그먼트 엔드포인트
사용자 데이터 식별자 또는 세그먼트별 전체 사용자 프로필, 글로벌 컨트롤 그룹별 사용자 사용자 데이터 엔드포인트
KPI 일일 활성 사용자, 월간 활성 사용자, 일일 신규 사용자, 날짜별 삭제 KPI 엔드포인트
세션 앱 세션 시계열 데이터 세션 엔드포인트
커스텀 이벤트 이벤트 이름, 이벤트 목록, 시간별 이벤트 분석 커스텀 이벤트 엔드포인트
커스텀 속성 속성 이름 커스텀 속성 엔드포인트
구매 시간별 매출 데이터, 제품 ID 목록, 구매 횟수 구매 엔드포인트

내보내기 데이터 전달 방식

API 내보내기는 대시보드에서 다운로드하는 CSV 파일과 달리 JSON 형식으로 데이터를 반환합니다. 전달 방식은 클라우드 스토리지 연결 여부에 따라 달라집니다.

  • 클라우드 스토리지 미연결 시: Braze는 자체 S3 버킷에 내보내기 파일을 기록하고 API 응답에 임시 다운로드 URL을 포함합니다. 이 URL은 4시간 후에 만료되며, 내보내기는 JSON 파일이 포함된 압축 아카이브(ZIP 또는 GZIP, output_format 매개변수에 따라 다름)로 패키징됩니다. JSON 파일의 각 줄은 하나의 데이터 오브젝트를 나타냅니다.
  • 클라우드 스토리지 연결 시: Braze는 구성된 버킷에 내보내기 파일을 직접 기록합니다. API 응답에는 다운로드 URL이 포함되지 않습니다. 파일은 자체 보존 정책을 따르며, 일반적으로 대규모 내보내기에 더 안정적입니다.

내보내기 전달 및 문제 해결에 대한 자세한 내용은 내보내기 문제 해결을 참조하세요.

내보내기 엔드포인트

다음 표는 사용 가능한 모든 내보내기 API를 나열합니다.

카테고리 메서드 엔드포인트
Campaigns GET Campaign Analytics
Campaigns GET Campaign Details
Campaigns GET Campaigns List
Campaigns GET Send Analytics
Canvases GET Canvas Data Series Analytics
Canvases GET Canvas Analytics Summary
Canvases GET Canvas Details
Canvases GET Canvas List
커스텀 이벤트 GET Custom Events
커스텀 이벤트 GET Custom Events List
커스텀 이벤트 GET Custom Event Analytics
커스텀 속성 GET Custom Attributes
KPI GET KPIs for Daily New Users by Date
KPI GET KPIs for Daily Active Users by Date
KPI GET KPIs for Monthly Active Users Over Last 30 Days
KPI GET KPIs for Uninstalls by Date
구매 GET Product IDs List
구매 GET Number of Purchases
구매 GET Revenue Data by Time
Segments GET Segment List
Segments GET Segment Analytics
Segments GET Segment Details
세션 GET App Sessions Time-Series Data
사용자 데이터 POST User Data by Identifier
사용자 데이터 POST User Data by Segment
사용자 데이터 POST User Data by Global Control Group

대시보드에서 일회성 내보내기를 수행하려면 다음 문서를 참조하세요.

New Stuff!