> For the complete documentation index, see [llms.txt](https://snapplay.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://snapplay.gitbook.io/docs/report-api.md).

# Report API

오퍼월 실적 및 이벤트 실적에 대한 보고서 데이터를 별도 API 로 제공합니다.

### 1. 오퍼월 보고서

* End Point : <https://adm.snaplay.io/adm/main/report/offerwall>
* 파라메터 (GET)
  * cust\_id : 고객사의 계정 ID 입니다. 고객사 페이지의 계정 정보에서 확인하실 수 있습니다.
  * api\_key : 보고서 API 호출에 대한 검증을 위해서 사용됩니다. 고객사 페이지의 계정 정보에서 확인하실 수 있습니다.
  * sday, eday : 조회 기간 시작 및 종료 일자입니다. yyyyMMdd 포맷입니다. 조회 기간은 최대 31일 입니다.
* 결과 데이터 (JSON)
  * ret\_cd : 0 이면 정상 조회, 그 외의 값은 오류입니다. 아래 오류 코드를 참고해주세요.
  * ret\_list : 보고서 데이터 배열입니다. 데이터 내의 컬럼 값은 아래와 같습니다.
    * pub\_id : 매체의 고유 ID (정수형)
    * plcmt\_nm : 플레이스먼트 명칭 (문자형)
    * adv\_cnt : 플레이스먼트에서 발생한 광고 실적 건수 (정수형)
    * clck\_cnt : 플레이스먼트에서 발생한 광고 클릭 건수 (정수형)
    * imp\_cnt : 플레이스먼트 노출 건수 (정수형)
    * pub\_amt : 플레이스먼트에서 발생한 매체 수익금
    * pub\_curr : 매체 수익금의 통화 단위
* 호출 예시&#x20;
  * <https://adm.snapplay.io/adm/main/report/offerwall?cust_id=0000&api_key=xxxxxxxxxxxxxxxxxx&sday=20260101&eday=20260131>
  * 결과 (예시)

```json
{
  "ret_cd": 0,
  "ret_list": [
    {
      "pub_id": 1065,
      "adv_cnt": 0,
      "imp_cnt": 1,
      "pub_amt": 0,
      "pub_curr": "KRW",
      "plcmt_nm": "cps_default",
      "clck_cnt": 0
    },
    {
      "pub_id": 1065,
      "adv_cnt": 0,
      "imp_cnt": 1,
      "pub_amt": 0,
      "pub_curr": "KRW",
      "plcmt_nm": "cps_index",
      "clck_cnt": 0
    },
    {
      "pub_id": 1065,
      "adv_cnt": 0,
      "imp_cnt": 5,
      "pub_amt": 0,
      "pub_curr": "KRW",
      "plcmt_nm": "cpu_click",
      "clck_cnt": 3
    }
  ]
}
```

### 2. 이벤트 보고서

* End Point : <https://adm.snaplay.io/adm/main/report/event>
* 파라메터 (GET)
  * cust\_id : 고객사의 계정 ID 입니다. 고객사 페이지의 계정 정보에서 확인하실 수 있습니다.
  * api\_key : 보고서 API 호출에 대한 검증을 위해서 사용됩니다. 고객사 페이지의 계정 정보에서 확인하실 수 있습니다.
  * sday, eday : 조회 기간 시작 및 종료 일자입니다. yyyyMMdd 포맷입니다. 조회 기간은 최대 31일 입니다.
* 결과 데이터 (JSON)
  * ret\_cd : 0 이면 정상 조회, 그 외의 값은 오류입니다. 아래 오류 코드를 참고해주세요.
  * ret\_list : 보고서 데이터 배열입니다. 데이터 내의 컬럼 값은 아래와 같습니다.
    * pub\_id : 매체의 고유 ID (정수형)
    * evt\_id : 이벤트의 고유 ID (정수
    * event\_nm : 이벤트 명칭 (문자형)
    * evt\_cnt : 이벤트 총 참여횟수 (정수형)
    * ticket\_cnt : 이벤트 참여 중 티켓을 사용하여 참여한 횟수 (정수형)
    * pnt\_cnt : 이벤트 참여를 통해서 유저에게 포인트가 지급된 횟수 (정수형)
    * ticket\_used : 사용된 총 티켓 수 (정수형)
    * user\_pnt : 유저에게 지급된 총 재화 (정수형)
    * pub\_amt : 이벤트에서 발생한 매체 수익금 (정수형)
    * pub\_curr : 매체 수익금의 통화 단위
* 호출 예시&#x20;
  * <https://adm.snapplay.io/adm/main/report/event?cust_id=0000&api_key=xxxxxxxxxxxxxxxxxx&sday=20260101&eday=20260131>
  * 결과 (예시)

```json
{
  "ret_cd": 0,
  "ret_list": [
    {
      "pub_id": 1065,
      "user_pnt": 120,
      "pub_amt": 20,
      "pub_curr": "KRW",
      "ticket_cnt": 0,
      "event_nm": "즉석복권 테스트",
      "evt_id": 307122,
      "evt_cnt": 4,
      "pnt_cnt": 4,
      "ticket_used": 0
    },
    {
      "pub_id": 1065,
      "user_pnt": 270,
      "pub_amt": 55,
      "pub_curr": "KRW",
      "ticket_cnt": 2,
      "event_nm": " 카드 게임 테스트",
      "evt_id": 313851,
      "evt_cnt": 11,
      "pnt_cnt": 8,
      "ticket_used": 6
    },
    {
      "pub_id": 1065,
      "user_pnt": 105,
      "pub_amt": 65,
      "pub_curr": "KRW",
      "ticket_cnt": 0,
      "event_nm": "주사위 모험 테스트 (해적)",
      "evt_id": 314492,
      "evt_cnt": 13,
      "pnt_cnt": 7,
      "ticket_used": 0
    },
    {
      "pub_id": 1065,
      "user_pnt": 6,
      "pub_amt": 25,
      "pub_curr": "KRW",
      "ticket_cnt": 0,
      "event_nm": "뽑기테스트",
      "evt_id": 316448,
      "evt_cnt": 5,
      "pnt_cnt": 5,
      "ticket_used": 0
    },
    {
      "pub_id": 1065,
      "user_pnt": 55,
      "pub_amt": 32,
      "pub_curr": "KRW",
      "ticket_cnt": 0,
      "event_nm": "치킨런 테스트",
      "evt_id": 320942,
      "evt_cnt": 8,
      "pnt_cnt": 8,
      "ticket_used": 0
    },
    {
      "pub_id": 1065,
      "user_pnt": 160,
      "pub_amt": 130,
      "pub_curr": "KRW",
      "ticket_cnt": 2,
      "event_nm": "로또볼 테스트",
      "evt_id": 328645,
      "evt_cnt": 18,
      "pnt_cnt": 3,
      "ticket_used": 50
    },
    {
      "pub_id": 1065,
      "user_pnt": 1778,
      "pub_amt": 825,
      "pub_curr": "KRW",
      "ticket_cnt": 0,
      "event_nm": "룰렛 테스트",
      "evt_id": 10000009,
      "evt_cnt": 165,
      "pnt_cnt": 165,
      "ticket_used": 0
    }
  ]
}
```

### Error Code <a href="#error-code" id="error-code"></a>

<table data-header-hidden><thead><tr><th></th><th width="374"></th></tr></thead><tbody><tr><td>Code</td><td>Description</td></tr><tr><td>0</td><td>Success</td></tr><tr><td>11</td><td>파라메터 누락</td></tr><tr><td>23</td><td>조회 기간 포맷 오류 (yyyyMMdd 포맷 아님)</td></tr><tr><td>24</td><td>권한 없음 (API_KEY 불일치)</td></tr><tr><td>30</td><td>조회 기간 오류 (최대 기간 31일)</td></tr></tbody></table>

### &#x20; <a href="#adv-and-action-types" id="adv-and-action-types"></a>
