AIR™ Reporting API

BizSpring AIR™ API 의 리포팅 데이터 획득 API를 설명합니다.

리포트 데이터 획득

BizSpring AIR™ 리포트의 분석 차원 데이터를 불러옵니다.

인증 토큰을 헤더(Header)에 담아 POST로 요청을 보내고, 요청 성공 시 응답 본문은 리포트 데이터를 포함한 JSON 객체를 반환합니다.

POST /report/data
HEADER
Content-Type: application/json
x-authorization: 

-- 이하 생략 --

요청 URL

https://growthplatform.ai/report/data

프로토콜

HTTPS

HTTP 메서드

POST

헤더

필드

설명

Content-type

요청 데이터 타입. application/json 으로 고정

x-authorization

사용자 인증 수단, 인증 토큰. Bearer }

Request Body

Request Body를 JSON 형식으로 전달합니다.

키

타입

설명

rpt_no*

string

BizSpring AIR™ 리포트 번호를 의미합니다.

예) 1000000 : 광고매체리포트

client_seq*

array

사이트 그룹 (광고주) 고유 식별 번호를 의미합니다.

where

array

특정 조건을 기준으로 하기 위한 조건절을 의미합니다.

stat_date
media_no
ad_type
ad_provider
ad_platform
ad_program
device
campaign
adgroup
keyword
report_type

항목별 스펙 참고 : where (조건절)

dim_cd

array

AIR 리포트에서 사용하는 분석차원을 의미합니다.

by_month
by_week
by_day
by_wday
media_no
ad_type
ad_provider
ad_platform
ad_program
campaign
adgroup
creative
keyword

항목별 스펙 참고 : dim_cd (분석차원)

client_seq는 AIR 에서 제공 중인 [AIR] > [API 쿼리 빌더] 사용 시 자동으로 입력됩니다.

API 쿼리 빌더는 매체 데이터를 JSON으로 쉽게 만들고 조회(사용)한 데이터가 성공적으로 기록되었는지 확인할 수 있도록 BizSpring AIR™에서 제공하는 서비스입니다.

요청 형식

아래는 요청의 기본 형식 입니다.

POST /report/data
HEADER
Content-Type: application/json
x-authorization: BEARER {AUTH TOKEN}

BODY
{
  "rpt_no": {REPORT_NO},
  "client_seq": [{CLIENT_SEQ}],
  "where": 
  [
    {
      "field":{FIELD},
      "operation":{OPERATION},
      "value":{VALUE}
    },
    { ... },
    { ... }
  ]
  "dim_cd": [{DIMENSION_CD}]
}

요청 예시

아래는 형식에 따라 임의 값을 부분적으로 제시한 예시입니다. (token 외 항목)

POST /report/data
HEADER
Content-Type: application/json
x-authorization: BEARER {AUTH TOKEN}

BODY  
{
  "rpt_no":"1000000",
  "client_seq":["105580"],
  "dim_cd":["by_day"]
  "where":
  [
    {
      "field":"stat_date",
      "operation":"between",
      "value":["2024-05-01","2024-05-08"]
    },
    {
      "field":"ad_provider",
      "operation":"in",
      "value":["네이버"]
    },
    {
      "field":"report_type",
      "operation":"equal",
      "value":"stat"
    }
  ]
}

응답 데이터 항목

응답에 성공하면 JSON 형식으로 결과값이 반환됩니다.

키

타입

설명

m_impr

int

매체사에서 제공하는 노출수를 의미합니다.

m_click

int

매체사에서 제공하는 클릭수를 의미합니다.

m_cost

int

매체사에서 제공하는 광고비를 의미합니다.

m_rgr

int

매체사에서 제공하는 가입수를 의미합니다.

m_odr

int

매체사에서 제공하는 주문율을 의미합니다.

m_cart

int

매체사에서 제공하는 장바구니수를 의미합니다.

m_conv

int

매체사에서 제공하는 전환수를 의미합니다.

m_rvn

double

매체사에서 제공하는 매출액을 의미합니다.

m_cpc

int

매체사에서 제공하는 클릭당 비용을 의미합니다.

m_ctr

int

매체사에서 제공하는 클릭률을 의미합니다.

m_crt

double

매체사에서 제공하는 전환률을 의미합니다.

m_roas

int

매체사에서 제공하는 광고 대비 수익률을 의미합니다.

land

int

랜딩페이지를 의미합니다.

rgr

int

전환율을 의미합니다.

odr

int

주문율을 의미합니다.

rvn

int

매출액을 의미합니다.

double