1 버전 기록
2 1. 개요
- 2.1 1.1 설명
3 2. 요청
- 3.1 2.1 설명
- 3.2 2.2 도메인 정보
- 3.3 2.3 Parameters
- 3.4 2.4. 요청 예시
4 3. 응답
- 4.1 3.1. 설명
- 4.2 3.2. 응답 기본 객체
- 4.3 3.3. data 객체
5 4. 코드 정의
- 5.1 4.1. 결과 코드
- 5.2 4.2. 결과 코드 400 응답 메세지
6 5. 응답 Sample

버전 기록

Date	Version	Notes

Date	Version	Notes
2024-12-18	1.0.0	릴리즈

1. 개요

1.1 설명

이 문서는 nap ssp 서비스를 사용하는 퍼블리셔를 위한 리포트 API 연동 가이드 문서입니다.

연동 및 이용 방법 문의 : nap_adx@nasmedia.co.kr

2. 요청

2.1 설명

nap ssp의 리포트 API로써, 퍼블리셔의 리포트 데이터를 제공합니다.
HTTP GET방식으로 정의된 객체를 작성합니다.
apiKey 값은 header 에 넣어야 하며, 나머지는 queryString 으로 요청합니다.
- apiKey는 파트너 사이트 → 계정 정보 에서 확인할 수 있습니다.
리포트 기간 조회 조건은 아래와 같습니다.
- 최근 6개월 이내
- 한번에 최대 30일

2.2 도메인 정보

구분	URL

구분	URL
상용	https://publisher.admixer.co.kr/api/v1/report/daily?

2.3 Parameters

항목	구분	필수	설명	값

항목	구분	필수	설명	값
apiKey	String(header)	✔️	nap ssp 파트너 사이트에서 발급 받은 api Key 확인 경로 : 파트너 사이트 > 계정> 계정관리 > ‘퍼블리셔 리포트 API KEY’
type	String(query)	✔️	리포트 유형(total, adunit)	total : 일자별 adunit : 애드유닛별
startDate	String(query)	✔️	조회 시작 날짜	YYYY-MM-DD
endDate	String(query)	✔️	조회 마지막 날짜 endDate는 startDate와 같거나, 그 이후여야 합니다. `(o) startDate=2024-10-10 endDate=2024-10-10, 11, 12 ....` `(x) startDate=2024-10-10 endDate=2024-10-09, 08, 07 ....`	YYYY-MM-DD

2.4. 요청 예시

curl -X GET -H "apiKey: nap ssp 파트너 사이트에서 발급받은 api Key" \
-H "Content-Type: application/json" \
"https://publisher.admixer.co.kr/api/v1/report/daily?type=total&startDate=2024-10-10&endDate=2024-10-10"

3. 응답

3.1. 설명

Admixer SSP 리포트 API는 아래 정의된 객체를 json형태로 응답합니다.

3.2. 응답 기본 객체

항목	설명	값

항목	설명	값
status	결과 코드	4.1. 결과코드 참고
code	코드
message	결과 메세지
data	리포트 응답이 삽입된 data	3.3. data 객체 참고

3.3. data 객체

이 조회 결과 데이터는 파트너 사이트에서 로그인 후 확인하는 정보와 일치합니다.

항목	설명

항목	설명
ymd	날짜 type=total인 경우만 노출
adunitId	애드유닛 ID type=adunit인 경우만 노출
adunitName	애드유닛 이름 type=adunit인 경우만 노출
req	요청수
calcImp	노출수
calcClick	클릭수
ctr	CTR
ecpmNet	eCPM (원화)
ecpmNetUsd	eCPM (달러)
fillrate	fillrate
cost	수익금 (원화)
costUsd	수익금 (달러)

4. 코드 정의

4.1. 결과 코드

status	설명

status	설명
200	성공
400	잘못된 요청, 4.2. 결과 코드 400 응답 메세지 참고
403	권한 없음
404	리포트를 찾을 수 없음
500	서버 내부 오류

4.2. 결과 코드 400 응답 메세지

응답 메세지	설명

응답 메세지	설명
유효하지 않은 API KEY 입니다.	header 의 apiKey 검증 실패
날짜 형식이 잘못되었습니다. yyyy-MM-dd 형식에 맞게 다시 요청해주세요.	startDate, endDate 날짜 형식이 잘못된 경우 예) 2024-10-10(o), 20241010 (x)
endDate는 startDate와 같거나, 그 이후여야 합니다. 다시 요청해주세요.	endDate가 startDate보다 이전인 경우
최근 180일 이내의 데이터만 조회할 수 있습니다. 다시 요청해주세요.	조회 일자가 최근 6개월보다 이전인 경우
한 번에 최대 30일치 데이터만 조회 가능합니다. 다시 요청해주세요.	조회 기간이 30일보다 긴 경우
잘못된 요청입니다. 다시 확인해주세요.	type 이 total & adunit 이 아닌 경우

5. 응답 Sample

type=total

{
  "status": 200,
  "code": "S001",
  "message": "SUCCESS",
  "data": [
    {
      "ymd": "20241209",
      "req": 2,
      "calcImp": 2,
      "calcClick": 0,
      "ctr": 0,
      "ecpmNet": 0,
      "ecpmNetUsd": 0,
      "fillrate": 100,
      "cost": 0,
      "costUsd": 0
    }
  ]
}

type=adunit

{
  "status": 200,
  "code": "S001",
  "message": "SUCCESS",
  "data": [
    {
      "adunitId": 1057,
      "adunitName": "배너_일반",
      "req": 2,
      "calcImp": 2,
      "calcClick": 0,
      "ctr": 0,
      "ecpmNet": 0,
      "ecpmNetUsd": 0,
      "fillrate": 100,
      "cost": 0,
      "costUsd": 0
    }
  ]
}