Actuals Report

    액츄얼스 리포트(Actuals Report)는 트래킹하고 있는 데이터를 자유롭게 확인할 수 있는 통계 리포트입니다.

    에어브릿지에서 제공하는 다양한 데이터 필드를 활용하여 메트릭을 지정하고 특정 기준(그룹바이)들로 데이터를 세분화하거나 필터를 적용하는 등 원하는 형태로 리포트를 커스텀하게 구성할 수 있습니다.


    리포트 생성하기

    POST

    https://api.airbridge.io/reports/api/v7/apps/{app_name}/actuals/query

    Actuals Report의 통계 데이터를 요청합니다.

    Request

    Path Params

    app_name
    필수string

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

    Body Params

    from
    필수string

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

    • YYYY-MM-DD 형태입니다.

    • 에어브릿지 앱의 타임존이 적용된 날짜이어야 합니다.

    • 현재로부터 365일 전까지 설정할 수 있습니다.

    to
    필수string

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

    • YYYY-MM-DD 형태입니다.

    • 에어브릿지 앱의 타임존이 적용된 날짜이어야 합니다.

    • 현재 날짜까지 설정할 수 있으며 최대 조회 기간은 92일입니다.

    groupBys
    필수string[]

    리포트 그룹바이.

    세분화하여 보고자 하는 항목을 ‘그룹바이'으로 설정하여 리포트를 조회할 수 있습니다. 액츄얼스 리포트에서 선택할 수 있는 전체 그룹바이 리스트는 리포트 그룹바이에서 확인할 수 있습니다.

    최대 10개까지 설정할 수 있습니다.

    metrics
    필수string[]

    리포트 메트릭.

    메트릭으로 다양한 광고 성과 데이터를 조회할 수 있습니다. 액츄얼스 리포트에서 선택할 수 있는 전체 메트릭 리스트는 리포트 메트릭에서 확인할 수 있습니다.

    최대 20개까지 설정할 수 있습니다.

    filters
    필수object[]

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

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

    filters[0].dimension
    필수string

    필터를 지정할 그룹바이.

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

    filters[0].filterType
    필수enum

    필터에 적용할 연산자.

    ENUM VALUES
    IN

    속해있다. 액츄얼스 리포트에서는 같다(is, =)에 대응합니다.

    NOT IN

    속해있지 않다. 액츄얼스 리포트에서는 같지 않다(is not, ≠)에 대응합니다.

    LIKE

    포함한다. (contains, ∋)

    NOT LIKE

    포함하지 않는다. (does not contain, ∌)

    EXIST

    값이 존재한다. (exists)

    NOT EXIST

    값이 존재하지 않는다. (does not exist)

    filters[0].values
    string[]

    필터에 적용할 값.

    sorts
    필수object[]

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

    sorts[0].fieldName
    필수string

    정렬에 사용할 그룹바이 또는 메트릭.

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

    sorts[0].isAscending
    boolean

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

    Response

    200 SUCCESS

    task.status

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

    PENDING

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

    RUNNING

    데이터를 집계중입니다.

    SUCCESS

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

    FAILURE

    요청이 실패하였습니다.

    CANCELED

    요청이 취소되었습니다.

    404 ERROR


    리포트 가져오기

    GET

    https://api.airbridge.io/reports/api/v7/apps/{app_name}/actuals/query/{task_id}

    비동기 요청 상태 정의

    비동기 요청 상태는 API 요청 결과의 task.status로 확인할 수 있습니다.

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

    PENDING

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

    RUNNING

    데이터를 집계중입니다

    SUCCESS

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

    FAILURE

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

    CANCELED

    요청이 취소되었습니다

    안내 메세지(Notification) 정의

    집계 과정에서 일부 데이터를 제거하거나 가려졌을 경우(마스킹), notification[0].code에 해당 사유를 확인할 수 있습니다.

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

    MEDIA_PARTNER_DATA_FILTERED_BY_CHANNEL

    미디어 파트너 권한으로 요청을 하여, 데이터 중 볼 수 없는 매체의 데이터를 제외하였습니다.

    AGG_DATA_MASKING_BY_FACEBOOK

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

    EXCEEDED_LIMIT_ON_MAX_ROW_COUNT

    요청에 해당하는 결과값이 10,000건을 넘습니다. Raw Data Export를 사용해 데이터를 추출하는 것을 권장합니다.

    SAN_PERIOD_LIMIT

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

    알립니다

    isMasked가 true이면 해당 cell의 값은 숨겨진 수치입니다.

    페이스북 개인정보 보호 정책으로 인해 페이스북 광고 노출이 1,000건 이하이거나 페이스북으로 기여된 설치수가 100건 이하인 데이터는 해당 수치를 보여주지 않습니다. 결과값의 values.<metrics>.isMasked가 true면 해당 value는 마스킹된 수치입니다.

    Request

    Path Params

    app_name
    필수string

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

    task_id
    필수string

    '리포트 생성하기' API의 결과값에서 반환한 task_id입니다.

    Query Params

    skip
    number

    결과값에서 제외할 Row의 수.

    size
    number

    반환할 Row 수.

    최대 사이즈는 100입니다.

    keyword
    string

    GroupBy에서 필터링할 검색 키워드.

    viewFormat
    boolean

    대시보드에서 Actuals Report에 대한 값을 표현해줄 때 사용하는 format 타입.

    true일 경우 마스킹한 값에 "Number + α" 형태로 표시합니다.

    Response

    200 (요청 처리중)SUCCESS

    비동기 요청을 처리하는 중입니다.

    해당 API를 주기적으로 폴링(Polling)하여 결과를 확인할 수 있으며, 요청 상태는 요청 상태는 task.status로 확인할 수 있습니다.

    200 (요청 결과 반환)SUCCESS

    데이터 집계가 완료된 결과를 반환합니다. statusSUCCESS일 경우, actuals에 데이터 및 메타데이터, 메세지 등을 담아 전송합니다.


    메타데이터 가져오기 (GroupBy)

    GET

    https://api.airbridge.io/dataspec/v2/apps/{app_name}/actual-report/fields

    사용할 수 있는 리포트 그룹바이를 조회합니다. [참고]

    Request

    Path Params

    app_name
    필수string

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

    Response

    200 SUCCESS

    404 ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.


    메타데이터 가져오기 (Metric)

    GET

    https://api.airbridge.io/dataspec/v2/apps/{app_name}/actual-report/metrics

    사용할 수 있는 리포트 메트릭을 조회합니다. [참고]

    Request

    Path Params

    app_name
    필수string

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

    Response

    200 SUCCESS

    404 ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.

    이 페이지가 도움이 되었나요?

    추가, 수정하면 좋을 내용이 있나요?