post https://api.airbridge.io/reports/api/v5/apps//retention/query
비동기 API 사용 방법
- Retention 리포트 비동기 요청하기 API 를 통해 taskId 를 생성합니다.
- Retention 리포트 비동기 결과 확인하기 API 에 생성한 taskId 를 이용해 Retention 리포트 비동기 결과 가져오기 API에서 결과를 확인합니다. (리포트 결과는 요청 Query 의 따라 약 5분까지 소요될 수 있습니다.)
- 리포트 Query 가 완료되면 Retention 리포트 비동기 결과 가져오기 API가 결과를 리턴합니다.
groupby.fields에 들어갈 수 있는 값
measurementOption 에 들어갈 수 있는 값
measurement option key | measurement option name | description |
---|---|---|
general_retention | General | 스타트 이벤트의 리턴 이벤트 대한 기여를 Lifetime으로 보아 분석 기간 전체의 사용자 Engagement를 확인하는 용도로 사용할 수 있습니다. 한 리턴 이벤트가 둘 이상 스타트 이벤트의 리텐션으로 계산될 수 있습니다. |
confined_retention | Confined | 리턴 이벤트에 대한 기여를 새로운 스타트 이벤트가 발생하기 전 까지로 한정하여 보아 각 스타트 이벤트별 사용자의 Engagement를 ‘General’ 옵션보다 조금 더 엄밀하게 확인하는 용도로 사용할 수 있습니다. |
startEvent에 들어갈 수 있는 값
event key | event name | description |
---|---|---|
app_installs | Installs (App) | 선택 기간 내 Install 한 사용자 (Unique Install) |
app_deeplink_opens | Deeplink Opens (App) | 선택 기간 내 Deeplink Open 한 사용자 (Unique Deeplink Open) |
API 한계
- 쿼리 가능한 최대 그룹바이 (groupBy) 수 : 3개
- 쿼리 가능한 최대 기간 (from ~ to) : 지난 30일