Skip to content

시간별 매출 데이터 내보내기

get

/purchases/revenue_series

이 엔드포인트를 사용하여 일정 기간 동안 앱에서 지출한 총 금액을 반환합니다.

필수 조건

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

사용량 제한

이 엔드포인트에는 시간당 1,000건의 요청에 대한 공유 사용량 제한이 적용됩니다. 이 사용량 제한은 API 사용량 제한 설명서에 설명된 대로 /custom_attributes, /events/events/list 엔드포인트와 공유됩니다.

요청 매개변수

매개변수 필수 데이터 유형 설명
ending_at 선택 사항 날짜/시간(ISO-8601 문자열) 데이터 내보내기가 종료되는 날짜입니다. 요청 시점이 기본값입니다.
length 필수 정수 반환되는 시리즈에 포함할 ending_at 이전 최대 일수입니다. 1에서 100 사이여야 합니다(경계값 포함).
unit 선택 사항 문자열 데이터 포인트 간의 시간 단위입니다. day 또는 hour를 지정할 수 있으며, 기본값은 day입니다.
app_id 선택 사항 문자열 API 키 페이지에서 가져온 앱 API 식별자입니다. 제외하면 워크스페이스의 모든 앱에 대한 결과가 반환됩니다.
product 선택 사항 문자열 응답을 필터링할 제품 이름입니다. 제외하면 모든 앱에 대한 결과가 반환됩니다.

요청 예시

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/purchases/revenue_series?length=100' \
--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,
      "revenue" : (int) amount of revenue for the time period
      },
    ...
  ]
}
New Stuff!