Adserver Report API

애드팝콘 SSP 에서 제공하는 Adserver 의 리포트 데이터를 가져오는 API 입니다.

URL

  • https://sspi-ext-report.adpopcorn.com/v1/analytics/data

Method

  • GET

Request Headers

NameTypeValue필수설명

Authorization

string

Bearer ${access_token}

Y

생성된 액세스 토큰을 ${access_token} 자리에 넣어 인증에 사용하세요.

예시 : curl “https://sspi-ext-report.adpopcorn.com/v1/analytics/data?fromDate=20220101&toDate=20220101” -H “Authorization: Bearer test_access_token” -L

Parameter

ParameterType필수설명

fromDate

string

Y

시작일

toDate

string

Y

종료일

Content-Type

  • application/json

Response parameter

Body parameterType설명

alert

string

서버에서 전송된 알림 메시지. 대부분의 경우 null일 것입니다. 예시: "alert": null

records

Array of object

리포트 데이터

Object

IDType설명

report_date

string

레포트 일자

campaign_id

string

광고 캠페인 UID

campaign_name

string

광고 캠페인 명

adset_id

string

adset id

adset_name

string

adset 이름

custom_id

string

custom id (custom id 사용 시)

impression

numeric

노출 수

click

numeric

클릭 수

adv_price

numeric

Revenue

json
{
   "alert": null,
   "records": [
     {
      "report_date": "20230601",
      "campaign_id": "c16850882834534z",
      "campaign_name": "인하우스",
      "adset_id": "s16850884077be4q",
      "adset_name": "카드",
      "impression": 3894,
      "click": 18,
      "adv_price": 3894
      }
    ]
}

서버 응답 코드

아래 표는 Adpopcorn API 플랫폼에서 REST API 응답으로 전송되는 일반적인 HTTP 상태 코드를 나열한 것입니다.

Code메세지설명

200

성공

요청이 성공적으로 처리되었습니다.

400

client-side 에러

유효성 검사에 실패했습니다.

401

인증되지 않음

인증 또는 권한 부여 실패가 발생했습니다.

500

API-side 에러

Adpopcorn API 플랫폼에 문제가 발생했습니다.

Last updated