리포트 생성하기

리텐션 리포트(Retention Report)는 유저가 얼마나 자주 서비스로 돌아왔는지를 측정할 수 있는 통계 리포트입니다. 에어브릿지 사용자는 특정 이벤트를 기준으로 설치 또는 딥링크로 유입된 유저의 일자별(Day N) 서비스 사용 빈도를 조회할 수 있습니다. 집계된 리텐션 성과는 광고 캠페인 최적화 등에 활용할 수 있습니다. 또한, 요청 횟수에 대한 제한이 없어 필요할 때마다 자유롭게 리포트를 생성할 수 있습니다. Retention Report 데이터를 요청합니다. rate limit: 일반적인 사용량에는 별도의 제한이 없습니다. 다만, 서비스 안정성을 위협하는 과도한 요청이 감지될 경우, 일시적으로 429 Too Many Requests 응답이 반환될 수 있습니다.

POST

https://api.airbridge.io/reports/api/v5/apps/{app_name}/retention/query

Request

Headers

string

API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

string

리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

string

API 요청에 사용하는 키값입니다. 키값 생성 및 조회 방법을 확인하여 획득할 수 있습니다.

Path Params

string

필수

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

Body Params

string

필수

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

YYYY-MM-DD 형태입니다.
에어브릿지 앱의 타임존이 적용된 날짜이어야 합니다.

string

필수

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

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

enum

필수

분석 기간 주기.

벨류	설명
`day`	일별로 데이터를 분석합니다.
`week`	주별로 데이터를 분석합니다. 시작일로부터 7일 단위로 계산됩니다.
`month`	월별로 데이터를 분석합니다. 시작일로부터 다음달 같은 일자까지를 같은 달로 계산합니다. 예를 들어 3월 10일이 시작일이면 4월 10일까지를 같은 달로 봅니다.
`hour`	시간별로 데이터를 분석합니다. 주기를 시간별로 설정하면 스타트 이벤트로 Install (App)만 설정할 수 있습니다.
`minute`	분별로 데이터를 분석합니다. 주기를 분별로 설정하면 스타트 이벤트로 Install (App)만 설정할 수 있습니다.

integer

주기에 따라 최대로 제공되는 구간 개수.리텐션 리포트 결과는 주기에 따라 조회 기간이 여러 구간으로 나뉘어 제공됩니다.

주기가 day, week, month면 기본값으로 각각 30, 11, 5를 사용합니다.
주기가 day, week, month면 최댓값은 각각 120, 52, 36입니다. 최솟값은 모두 0입니다.
주기가 hour, minute이면 값으로 각각 59, 23을 사용합니다. 다른 값을 사용할 수 없습니다.
결과는 0번째 구간부터 시작합니다.

enum[]

필수

유저를 유입시킨 이벤트.최소 1개의 스타트 이벤트를 선택해야 합니다. 서비스 또는 캠페인 특성에 따라 여러 개의 스타트 이벤트를 설정할 수 있습니다.

벨류	설명
`app_installs`	Installs (App). 선택 기간 내 Install 한 사용자 (Unique Install)
`app_deeplink_opens`	Deeplink Opens (App). 선택 기간 내 Deeplink Open 한 사용자 (Unique Deeplink Open)
`app_deeplink_pageviews`	Deeplink Pageviews (App). 선택 기간 내 Deeplink Pageview 한 사용자 (Unique Deeplink Pageview)
`app_sign_up`	회원가입 (App). 선택 기간 내 앱 회원가입한 사용자 (Unique Sign-up)
`app_sign_in`	로그인 (App). 선택 기간 내 앱 로그인 사용자 (Unique Sign-in)
`app_order_complete`	구매 완료 (App). 선택 기간 내 앱에서 구매 완료한 사용자 (Unique Order Complete)

enum[]

필수

스타트 이벤트를 실행한 유저가 발생시킨 리턴 이벤트. 서비스 또는 캠페인 특성에 따라 여러 개의 리턴 이벤트를 설정할 수 있습니다.

벨류	설명
`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를 수행한 사용자 중 선택 기간 내 수행한 구독 이벤트.

enum

필수

User Journey를 바라보는 관점에서 리텐션을 분석할 수 있도록 설정. 참고

벨류	설명
`general_retention`	General. 스타트 이벤트의 리턴 이벤트 대한 기여를 Lifetime으로 보아 분석 기간 전체의 사용자 Engagement를 확인하는 용도로 사용할 수 있습니다. 한 리턴 이벤트가 둘 이상 스타트 이벤트의 리텐션으로 계산될 수 있습니다.
`confined_retention`	Confined. 리턴 이벤트에 대한 기여를 새로운 스타트 이벤트가 발생하기 전 까지로 한정하여 보아 각 스타트 이벤트별 사용자의 Engagement를 ‘General’ 옵션보다 조금 더 엄밀하게 확인하는 용도로 사용할 수 있습니다.

object

필수

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

표시 하위 변수

string[]

필수

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

object[]

최대 1개의 코호트를 설정할 수 있습니다.

표시 하위 변수

number

필수

0으로 입력해 주세요. 다른 값은 지원하지 않습니다.

string

필수

Cohort로 입력해 주세요. 다른 값은 지원하지 않습니다.

object

필수

리텐션 리포트에서 사용하는 코호트를 정의합니다. 항상 andClauses, orClauses, segment 순서로 하위 변수를 정의합니다. 아래에서 각 변수의 관계를 확인하세요.groupBy.cohorts[0].definition.andClauses (object[]) 필수코호트 정의의 최상위 조건입니다. 설정한 조건을 모두 and로 연결합니다. 하위 변수로 negated와 orClauses를 반드시 설정해야 합니다.

negated (boolean): orClauses에 설정한 조건의 부정 여부를 설정합니다.
- true: orClauses에 설정한 조건을 부정합니다. 따라서 orClauses에 설정한 조건이 거짓입니다.
- false: orClauses에 설정한 조건을 부정하지 않습니다. 따라서 orClauses에 설정한 조건이 참입니다.

groupBy.cohorts[0].definition.andClauses[*].orClauses (object[]) 필수andClauses 하위에 설정하는 조건입니다. 설정한 조건을 모두 or로 연결합니다. 하위 변수로 negated 와 segment를 반드시 설정해야 합니다.

negated (boolean): segment에 설정한 조건의 부정 여부를 설정합니다.
- true: segment에 설정한 조건을 부정합니다. 따라서 segment에 설정한 조건이 거짓입니다.
- false: segment에 설정한 조건을 부정하지 않습니다. 따라서 segment에 설정한 조건이 참입니다.

groupBy.cohorts[0].definition.andClauses[*].orClauses[*].segment (object) 필수코호트 정의의 최소 조건입니다. 하위 변수로 event, filters, time을 설정할 수 있습니다.

event (object): 유저가 발생시킨 이벤트와 이벤트 발생 횟수를 정의할 수 있습니다. 하위 변수로 type, operator, value를 설정할 수 있습니다.
- type (string): 유저가 발생시킨 이벤트를 설정합니다. any-event를 사용하면 모든 이벤트로 설정할 수 있습니다. 설정할 수 있는 다른 이벤트는 [에어브릿지 데이터 스펙]>[Retention Report - Audience Events]의 Event Key 열에서 확인할 수 있습니다. -, _ 사용에 주의해 주세요.
- operator (enum): 이벤트 발생 횟수에 사용하는 비교 연산자를 설정할 수 있습니다. equals, more than or equals, more than, less than or equals, less than 등 총 5가지 중에서 1가지만 사용할 수 있습니다 .
- value (number): 이벤트 발생 횟수를 설정할 수 있습니다. 자연수를 입력해 주세요.
filters (object[]): 정의한 이벤트 중 특정 이벤트만 확인할 수 있습니다. 코호트 정의의 had property와 같습니다. 하위 변수로 field, filterType를 설정할 수 있습니다.
- field (string): 필터로 설정할 수 있는 프로퍼티입니다. 설정할 수 있는 프로퍼티는 [에어브릿지 데이터 스펙]>[Retention Report - Audience Properties]의 Property Key 열을 참고해 주세요.
- filterType (enum): 프로퍼티에 사용할 수 있는 연산자를 설정합니다. 설정한 프로퍼티에 따라 사용할 수 있는 연산자와 필터로 설정하는 값(없음, value, values)이 변경됩니다

filterType	프로퍼티 데이터 타입	하위 변수
is / is not	string, boolean	values
contains / does not contain	string	value
exists / does not exist	string, boolean, int, float	없음
equals / does not equal	int, float	value
does not equal	int, float	value
greater than or equals	int, float	value
greater than	int, float	value
less than or equals	int, float	value
less than	int, float	value
between	int, float	values
does not between	int, float	values

time (object): 이벤트가 발생한 시각에 대한 조건을 설정할 수 있습니다. 설정한 조건에 따라 하위 변수가 변경됩니다.
- operator (enum): during, between, since 중에서 조건을 설정합니다. 3가지 중에서 1가지만 설정할 수 있습니다. 조건이 between이면 조회 기간은 2023년 2월 1일부터 설정할 수 있습니다. 최대로 설정할 수 있는 조회 기간은 90일입니다.

operator	하위 변수	설명
during	values, isNowEnabled	isNowEnabled은 오늘 포함 여부를 설정합니다
between	values	values에 시작일과 종료일을 모두 설정해야 합니다
since	values	시작일만 설정합니다

object[]

필수

‘그룹바이’로 제공하는 항목들에 대한 필터.조건을 만족하는 데이터에 대한 통계 데이터를 리포트에서 조회할 수 있습니다.

표시 하위 변수

string

필수

필터를 지정할 그룹바이.groupBys 내에 정의된 값만 사용하실 수 있습니다.

enum

필수

필터에 적용할 연산자.

벨류	설명
`IN`	속해있다. 액츄얼스 리포트에서는 같다(is, =)에 대응합니다.
`NOT IN`	속해있지 않다. 액츄얼스 리포트에서는 같지 않다(is not, ≠)에 대응합니다.
`LIKE`	포함한다. (contains, ∋)
`NOT LIKE`	포함하지 않는다. (does not contain, ∌)
`EXIST`	값이 존재한다. (exists)
`NOT EXIST`	값이 존재하지 않는다. (does not exist)

string[]

필터에 적용할 값.

object[]

필수

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

표시 하위 변수

string

필수

정렬에 사용할 그룹바이 또는 메트릭.groupBys 또는 metrics 내에 정의된 값만 사용하실 수 있습니다.

boolean

정렬 기준의 오름차순(A-Z) 여부. (기본값: true)

string

group by를 필터링 할 수 있는 값.

object

표시 하위 변수

integer

필수

skip할 row의 수.

integer

필수

query 할 row의 수. 기본값: 100

curl -X POST 'https://api.airbridge.io/reports/api/v5/apps/{app_name}/retention/query' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -d '{
  "from": "2022-11-04",
  "to": "2022-11-11",
  "granularity": "day",
  "intervalsPeriod": 30,
  "startEvents": [
    "app_installs"
  ],
  "returnEvents": [
    "app_order_complete"
  ],
  "measurementOption": "general_retention",
  "groupBy": {
    "fields": [
      "channel"
    ]
  },
  "filters": [
    {
      "field": "campaign",
      "filterType": "IN",
      "values": [
        "App"
      ]
    }
  ],
  "sorts": [
    {
      "fieldName": "event_type",
      "isAscending": true
    }
  ],
  "pagination": {
    "skip": 0,
    "size": 50
  }
}'

Response

200

400

{
  "data": {
    "taskId": "5e286bd4-b4b1-4c04-8f6a-123456789abc"
  }
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "traceId": "1-000000-000000000000000"
}

API Reference

Tracking Link

Server-to-Server Events

Actuals Report

Revenue Report

Retention Report

Active Users Report

Raw Data

Attribution Result

Self-Serve Data Upload

SKAdNetwork Configuration API

Request

Headers

Path Params

Body Params

Response

200

400

​Request

​Headers

​Path Params

​Body Params

​Response

​200

​400

Request

Headers

Path Params

Body Params

Response

200

400