Revenue Report

Path Params

app_name

필수string

에어브릿지 앱 이름(App Name)

Body Params

from

필수datetime

요청할 리포트 데이터의 시작일.

YYYY-MM-DD 형태입니다.
에어브릿지 앱의 타임존이 적용된 날짜이어야 합니다.
현재로부터 174일 전까지 설정할 수 있습니다.

필수datetime

요청할 리포트 데이터의 종료일.

YYYY-MM-DD 형태입니다.
에어브릿지 앱의 타임존이 적용된 날짜이어야 합니다.
현재 날짜까지 설정할 수 있으며 최대 조회 기간은 31일입니다.

groupBy

필수object

그룹바이는 조회할 메트릭의 수치를 나누는 기준입니다.
조회에 사용할 그룹바이 항목 혹은 코호트를 설정할 수 있습니다.

groupBy.fields

필수string[]

리포트 그룹바이.

최대 4개의 그룹바이를 설정할 수 있으며, 선택할 수 있는 리스트는 그룹바이 목록에서 확인할 수 있습니다.

granularity

필수enum

분석 기간 주기.

ENUM VALUES

day

일별로 데이터를 분석합니다.

week

주별로 데이터를 분석합니다. 시작일로부터 7일 단위로 계산됩니다.

month

월별로 데이터를 분석합니다. 시작일로부터 다음달 같은 일자까지를 같은 달로 계산합니다. 예를 들어 3월 10일이 시작일이면 4월 10일까지를 같은 달로 봅니다.

startEvents

필수enum[]

설정한 기간에 유저가 유입되면서 발생한 이벤트.

스타트 이벤트를 실행하지 않은 유저는 레비뉴 리포트의 분석 대상에서 제외됩니다.

ENUM VALUES

app_install

Install (App). 선택 기간 내 발생한 Install 이벤트.

app_deeplink_open

Deeplink Open (App). 선택 기간 내 발생한 Deeplink Open 이벤트.

returnEvents

필수enum[]

스타트 이벤트를 실행한 유저가 발생시킨 매출 이벤트.

운영하는 서비스에서 매출이 발생하는 형태에 따라 여러 개의 레비뉴 이벤트를 설정할 수 있습니다.

ENUM VALUES

app_order_complete

구매 완료 (App). Start Event를 수행한 사용자 중 선택 기간 내 수행한 구매 완료 이벤트.

app_first_order_complete

첫 구매 완료 (App). Start Event를 수행한 사용자 중 선택 기간 내 수행한 첫 구매 이벤트.

app_ad_impression

Ad Impression (App). Start Event를 수행한 사용자 중 선택 기간 내 수행한 광고 노출 이벤트.

app_ad_click

광고 클릭 (App). Start Event를 수행한 사용자 중 선택 기간 내 수행한 광고 클릭 이벤트.

app_subscribe

구독 (App). Start Event를 수행한 사용자 중 선택 기간 내 수행한 구독 이벤트.

metric

필수enum

레비뉴 리포트 메트릭.

스타트 이벤트와 레비뉴 이벤트를 실행한 유저를 대상으로 아래의 메트릭을 일자별로 계산할 수 있습니다.

ENUM VALUES

app_revenue

Revenue (App). 앱에서 발생한 결제의 매출액 (현지 통화기준). cumulative, on-day 집계 방식을 지원합니다.

app_user_count

User Count (App). 레비뉴 이벤트를 실행한 고유 유저수

app_event_count

Event Count (App). 레비뉴 이벤트 횟수

app_roas

ROAS (App). 광고 비용당 매출. 마케팅 활동에 지출한 비용 대비 매출액 (현지 통화 기준). cumulative 집계 방식만 지원합니다.

app_arpu

ARPU (App). 유저당 평균 매출액 (현지 통화기준). cumulative 집계 방식만 지원합니다.

app_arppu

ARPPU (App). 결제 유저(Paying User)당 평균 매출액.

aggregationType

필수enum

데이터의 집계 방식. [참고]

ENUM VALUES

cumulative

누적 집계. 분석 기간 첫 날(Day 0)부터 마지막 날(Day N)까지의 수치를 누적합니다.

on-day

분절 집계. 수치를 누적하지 않고 날짜 단위로 분절합니다.

filters

object[]

'그룹바이'로 제공하는 항목들에 대한 필터.

조건을 만족하는 데이터에 대한 통계 데이터를 리포트에서 조회할 수 있습니다.

filters[0].field

string

필터를 지정할 그룹바이.

groupBys 내에 정의된 값만 사용하실 수 있습니다.

filters[0].filterType

enum

필터에 적용할 연산자.

ENUM VALUES

IS

같다.

IS NOT

같지 않다.

EXIST

값이 존재함.

NOT EXIST

값이 존재하지 않음.

filters[0].values

string

필터에 적용할 값.

sorts

필수object[]

'그룹바이' 또는 '메트릭'을 기준으로 리포트 데이터를 정렬할 수 있습니다.

sorts.[0].fieldName

필수string

필터를 지정할 그룹바이 또는 메트릭.

groupBy.dimensions 또는 subMetrics 내에 정의된 값만 사용하실 수 있습니다.

sorts.[0].isAscending

boolean

오름차순 정렬.

true: 오름차순
false: 내림차순

resultSpec

object

결과 값의 형태를 선택할 수 있습니다.

resultSpec.csv

object

csv의 형태를 설정합니다.

resultSpec.csv.includesMetadata

boolean

metadata 를 포함할지 여부. (선택한 startEvent, groupBy 등)

resultSpec.csv.includesTotal

boolean

total 데이터를 포함할지 여부.

Request

12345
curl -X POST 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query' \
  -H 'Aceept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{"from":"2023-01-01","to":"2023-01-07","groupBy":{"fields":["channel"]},"granularity":"day","startEvents":["app_install"],"returnEvents":["app_order_complete"],"metric":"app_revenue","aggregationType":"cumulative","sorts":[{"fieldName":"totalRevenue","isAscending":true}],"resultSpec":{"csv":{"includesTotal":true}}}'

Payload

1234567891011121314151617181920212223242526272829
{
  "from": "2023-01-01",
  "to": "2023-01-07",
  "groupBy": {
    "fields": [
      "channel"
    ]
  },
  "granularity": "day",
  "startEvents": [
    "app_install"
  ],
  "returnEvents": [
    "app_order_complete"
  ],
  "metric": "app_revenue",
  "aggregationType": "cumulative",
  "sorts": [
    {
      "fieldName": "totalRevenue",
      "isAscending": true
    }
  ],
  "resultSpec": {
    "csv": {
      "includesTotal": true
    }
  }
}

`#{"style":{"minWidth":"130px"}}` `PENDING`	데이터 집계를 위한 준비를 하고 있습니다
`RUNNING`	데이터를 집계중입니다
`SUCCESS`	집계가 완료되어 결과값을 반환합니다
`FAILURE`	알 수 없는 이유로 요청이 실패하였습니다
`CANCELED`	요청이 취소되었습니다

#{"style":{"minWidth":"130px"}}

PENDING

데이터 집계를 위한 준비를 하고 있습니다

RUNNING

데이터를 집계중입니다

SUCCESS

집계가 완료되어 결과값을 반환합니다

FAILURE

알 수 없는 이유로 요청이 실패하였습니다

CANCELED

요청이 취소되었습니다

`#{"style":{"minWidth":"310px"}}` `AGG_DATA_MASKING_BY_FACEBOOK`	페이스북 개인정보 보호 정책으로 인해 일부 데이터가 제거되거나 가려졌습니다.
`SAN_PERIOD_LIMIT`	페이스북 등 Self-Attributed Network에 기여된 데이터 중 175일 이전의 데이터를 제거하였습니다.

#{"style":{"minWidth":"310px"}}

AGG_DATA_MASKING_BY_FACEBOOK

페이스북 개인정보 보호 정책으로 인해 일부 데이터가 제거되거나 가려졌습니다.

SAN_PERIOD_LIMIT

페이스북 등 Self-Attributed Network에 기여된 데이터 중 175일 이전의 데이터를 제거하였습니다.

curl -X GET 'https://api.airbridge.io/reports/api/v3/apps/{app_name}/revenue/query/{task_id}' \ -H 'Aceept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

{ "data": { "stats": { "rows": [ { "rows": [ { "date": "2021-11-01", "total": { "totalCost": { "value": 0 }, "totalRevenue": { "value": 10 }, "totalUniqueUsers": { "value": 1, "isMasked": true } }, "values": [ { "value": 1, "isMasked": false }, { "value": 2, "isMasked": false }, { "value": 3, "isMasked": false }, { "value": 4, "isMasked": false } ] } ], "total": { "rows": [ { "value": 1, "isMasked": false }, { "value": 2, "isMasked": false }, { "value": 3, "isMasked": false }, { "value": 4, "isMasked": false } ], "totalCost": { "value": 0 }, "totalRevenue": { "value": 10.45 }, "totalUniqueUsers": { "value": 1, "isMasked": false } }, "metadata": [ "<groupBy>" ] } ] }, "status": "SUCCESS", "taskId": "5e286bd4-b4b1-4c04-8f6a-670dc7ce637d", "endedAt": "2022-01-17T19:10:00.286939+09:00", "hasNext": false, "metadata": { "totalCount": 48 } }, "notification": [ { "code": "AGG_DATA_MASKING_BY_FACEBOOK", "type": "info", "message": "some data is masked by facebook privacy policy." } ] }

리포트 생성하기

Request

Path Params

Body Params

Response

200 SUCCESS

400 ERROR

리포트 가져오기

Request

Path Params

Query Params

Response

200 SUCCESS

404 ERROR

Revenue Reportself.__wrap_n!=1&&self.__wrap_b(":R29lllb7ammda:",0.5)

리포트 생성하기

Request

Path Params

Body Params

Response

200 SUCCESS

400 ERROR

리포트 가져오기

Request

Path Params

Query Params

Response

200 SUCCESS

404 ERROR

Revenue Report