Report API Guide

카카오 AD Exchange와 RTB 연동한 DSP에게 제공하는 리포트 API 가이드입니다.

1. 문서 버전

날짜
버전
내용

2025-10-13

0.1

초안 작성

2. 개요

리포트 API 가이드 문서입니다.

3. API

Https 는 필수입니다.

domain

https://adx.kakao.com

3.1 리포트 등록 API

DSP가 DSP의 리포트를 카카오에 등록하기 위한 API 입니다.

3.1.1 리포트 등록 API

DSP가 리포트를 등록(json)하는 API 입니다.

circle-info

전월 정산마감 이후에는 전월 데이터 수정이 불가합니다. (예시 - 10월 정산마감 이후 10월 리포트 수정 불가)

3.1.1.1 Request

  • Path : POST /external/api/v1/dsp/report/json

  • Header

name
type
required
value
description

Authorization

string

true

Bearer ${accessToken}

accessToken은 카카오 담당자가 발급하여 전달

Content-Type

string

true

application/json

서버로 전송하는 데이터 타입 명시

Accept

string

true

application/json

서버로부터 받고자 하는 데이터 유형

  • Request Parameter

parameter
type
required
sample value
description

currency

string

false

KRW

통화 종류(KRW, USD) 기본값은 KRW

  • Request Body

parameter
type
required
sample value
description

[].reportDate

string

true

2023-01-01

리포트 일자

[].adunitId

string

true

0Qv33

광고단위 아이디

[].cnt

long

true

1000

노출 카운트

[].sales

double

true

1000.5

매출

[].click

long

false

100

클릭 카운트

3.1.1.2 Response

  • Response Body

circle-info

정상 - 201(CREATED)

column
type
name
description

-

-

-

-

circle-info

인증 실패 - 401(UNAUTHORIZED)

column
type
name
description

code

string

UNAUTHORIZED

message

string

인증실패

details

string

jwt token authentication failed!

circle-info

에러 - 500(INTERNAL SERVER ERROR)

column
type
name
description

code

string

INTERNAL SERVER ERROR

message

string

서버에러

details

string

error...

3.1.1.3 Example

  • Request

circle-info

currency = KRW 일 경우

circle-info

currency = USD 일 경우

  • Response


3.2 리포트 조회 API

DSP가 카카오에 등록한 DSP의 리포트를 조회하기 위한 API 입니다.

3.2.1 리포트 API

DSP가 등록한 리포트 조회(json) API 입니다.

3.2.1.1 Request

  • Path : GET /external/api/v1/dsp/report

  • Header

name
type
required
sample value
description

Authorization

string

true

Bearer ${accessToken}

accessToken은 카카오 담당자가 발급하여 전달

Accept

string

true

application/json

서버로부터 받고자 하는 데이터 유형

  • Request Parameter

parameter
type
required
sample value
description

start

string

true

2023-01-01

조회 시작 일자

end

string

true

2023-01-07

조회 종료 일자

3.2.1.2 Response

  • Response Body

circle-info

정상 - 200(OK) : KRW 예시

column
type
sample value
description

reportDate

string

2023-01-01

리포트 일자

dspId

string

TEST_DSP

adunitId

string

0Qv33

광고단위

cnt

long

100

노출 카운트

sales

double

1000.0

매출(KRW)

click

long

10

클릭 카운트

originalSales

double

1000.0

원본 매출

originalCurrency

string

KRW

통화

exhangeRate

double

1.0

환율

circle-info

정상 - 200(OK) : USD 예시

column
type
sample value
description

reportDate

string

2023-01-01

리포트 일자

dspId

string

TEST_DSP

adunitId

string

0Qv33

광고단위

cnt

long

100

노출 카운트

sales

double

1353.6

매출(KRW)

click

long

10

클릭 카운트

originalSales

double

1.0

원본 매출

originalCurrency

string

USD

원본 통화

exhangeRate

double

1353.6

환율 (하나은행, 리포트 일자 23:30 기준 고시환율)

circle-info

인증 실패 - 401(UNAUTHORIZED)

column
type
sample value
description

code

string

UNAUTHORIZED

message

string

인증실패

details

string

jwt token authentication failed!

circle-info

에러 - 500(INTERNAL SERVER ERROR)

column
type
sample value
description

code

string

INTERNAL SERVER ERROR

message

string

서버에러

details

string

error...

3.2.1.3 Example

circle-info

currency = KRW 일경우

  • Request

  • Response

circle-info

currency = USD 일경우

  • Request

  • Response


3.2.2 Report CSV Download API

DSP가 카카오에 등록한 리포트를 CSV 다운로드하는 API 입니다.

3.2.2.1 Request

  • Path : GET /external/api/v1/dsp/report/csv

  • Header

name
type
required
sample value
description

Authorization

string

true

Bearer ${accessToken}

accessToken은 카카오 담당자가 발급하여 전달

  • Request Parameter

parameter
type
required
sample value
description

start

string

true

2023-01-01

조회 시작 일자

end

string

true

2023-01-07

조회 종료 일자

3.2.2.2 Response

  • Response Body

circle-info

정상 - 200(OK) : KRW 예시 CSV File Download

column
type
sample value
description

reportDate

string

2023-01-01

리포트 일자

dspId

string

TEST_DSP

adunitId

string

0Qv33

광고단위

cnt

long

100

노출 카운트

sales

double

1000.0

매출(KRW)

click

long

10

클릭 카운트

originalSales

double

1000.0

원본 매출

originalCurrency

string

KRW

원본 통화

exhangeRate

double

1.0

환율

circle-info

정상 - 200(OK) : USD 예시 CSV File Download

column
type
sample value
description

reportDate

string

2023-01-01

리포트 일자

dspId

string

TEST_DSP

adunitId

string

0Qv33

광고단위

cnt

long

100

노출 카운트

sales

double

1000.0

매출(KRW)

click

long

10

클릭 카운트

originalSales

double

100.5

원본 매출

originalCurrency

string

USD

원본 통화

exhangeRate

double

1398.8

환율

circle-info

인증 실패 - 401(UNAUTHORIZED)

column
type
sample value
description

code

string

UNAUTHORIZED

message

string

인증실패

details

string

jwt token authentication failed!

circle-info

에러 - 500(INTERNAL SERVER ERROR)

column
type
sample value
description

code

string

INTERNAL SERVER ERROR

message

string

서버에러

details

string

error...

3.2.2.3 Example

  • Request


3.2.3 카카오 리포트 API

카카오 리포트 조회(json) API 입니다.

circle-info

Kakao Report는 2023/09/01 부터의 데이터만 조회 가능합니다.

한 번에 조회 가능한 기간은 최대 7일 입니다.

3.2.3.1 Request

  • Path : GET /external/api/v1/dsp/report/kakao

  • Header

name
type
required
sample value
description

Authorization

string

true

Bearer ${accessToken}

accessToken은 카카오 담당자가 발급하여 전달

Accept

string

true

application/json

서버로부터 받고자 하는 데이터 유형

  • Request Parameter

parameter
type
required
sample value
description

start

string

true

2023-09-01

조회 시작 일자

end

string

true

2023-09-07

조회 종료 일자

3.2.3.2 Response

  • Response Body

circle-info

정상 - 200(OK)

column
type
sample value
description

reportDate

string

2023-01-01

리포트 일자

dspId

string

TEST_DSP

adunitId

string

0Qv33

광고단위

cnt

long

100

노출 카운트

sales

double

1000.0

매출(KRW)

click

long

10

클릭 카운트

circle-info

인증 실패 - 401(UNAUTHORIZED)

column
type
sample value
description

code

string

UNAUTHORIZED

message

string

인증실패

details

string

jwt token authentication failed!

circle-info

에러 - 500(INTERNAL SERVER ERROR)

column
type
sample value
description

code

string

INTERNAL SERVER ERROR

message

string

서버에러

details

string

error...

3.2.3.3 Example

  • Request

  • Response


3.2.4 카카오 리포트 CSV Download API

카카오 리포트를 CSV 다운로드하는 API 입니다.

circle-info

Kakao Report는 2023/09/01 부터의 데이터만 조회 가능합니다.

한 번에 조회 가능한 기간은 최대 7일 입니다.

3.2.4.1 Request

  • Path : GET /external/api/v1/dsp/report/kakao/csv

  • Header

name
type
required
sample value
description

Authorization

string

true

Bearer ${accessToken}

accessToken은 카카오 담당자가 발급하여 전달

  • Request Parameter

parameter
type
required
sample value
description

start

string

true

2023-01-01

조회 시작 일자

end

string

true

2023-01-07

조회 종료 일자

3.2.4.2 Response

  • Response Body

circle-info

정상 - 200(OK) CSV File Download

column
type
sample value
description

reportDate

string

2023-01-01

리포트 일자

dspId

string

TEST_DSP

adunitId

string

0Qv33

광고단위

cnt

long

100

노출 카운트

sales

double

1000.0

매출

click

long

10

클릭 카운트

circle-info

인증 실패 - 401(UNAUTHORIZED)

column
type
sample value
description

code

string

UNAUTHORIZED

message

string

인증실패

details

string

jwt token authentication failed!

circle-info

에러 - 500(INTERNAL SERVER ERROR)

column
type
sample value
description

code

string

INTERNAL SERVER ERROR

message

string

서버에러

details

string

error...

3.2.4.3 Example

  • Request

Last updated

Was this helpful?