본문으로 건너뛰기

통계

통계 API v3 레퍼런스 바로가기
버전별 기능 범위 안내
  • v1 미지원: v1에서는 통계 관련 기능을 지원하지 않습니다.
  • 공통 인증: 모든 버전의 API는 쿼리 스트링 파라미터(?access_token=)를 통한 공통 인증 방식을 사용합니다. 에러 판정 기준에 대한 공통 명세는 API v3 마이그레이션 가이드의 핵심 변경 사항 섹션을 참고하세요.

전체 콘텐츠 시청 순위 조회​

  • 기존 (v1/v2): 미지원
  • 변경 (v3): GET /statistics/content-rank
응답 최상위 키 예외 구조

대부분의 v3 API와 달리, 최상위 키로 result_data를 사용합니다. 클라이언트 애플리케이션에 API 공통 응답 파서를 적용할 경우 데이터가 누락될 수 있으므로, 반드시 예외 처리를 구현해야 합니다.

요청 파라미터 및 응답 구조 상세

요청 쿼리 파라미터​

파라미터데이터 타입필수 여부설명
start_dateString필수조회 범위 시작 날짜 (YYYYMMDD)
end_dateString필수조회 범위 종료 날짜 (YYYYMMDD)
keywordString선택검색 키워드 필터링
start_indexInteger선택결과 리스트의 시작 번호
limitInteger선택최대 출력 데이터 개수 (0: 전체 데이터 조회)

응답 구조 명세​

{
  "result_data": [
    {
      "avg_play_rate": 85.5,
      "avg_uplay_rate": 80.2,
      "category_id": 10,
      "channel_key": "channel_key_string",
      "content_id": 1,
      "title": "top1_content_title",
      "upload_time": "2025-12-22 01:28:39",
      "upload_key": "upload_key_string",
      "duration": 3600,
      "count": 500,
      "play_count": 450
    }
  ]
}

채널 내 콘텐츠 시청 순위 조회​

  • 기존 (v1/v2): 미지원
  • 변경 (v3): GET /channels/{channel_key}/statistics/content-rank
응답 최상위 키 예외 구조

대부분의 v3 API와 달리, 최상위 키로 result_data를 사용합니다. 클라이언트 애플리케이션에 API 공통 응답 파서를 적용할 경우 데이터가 누락될 수 있으므로, 반드시 예외 처리를 구현해야 합니다.

요청 파라미터 및 응답 구조 상세

요청 파라미터​

  • 경로 파라미터 (Path): 대상 채널을 지정하기 위한 channel_key(필수)가 URL에 포함되어야 합니다.
  • 쿼리 파라미터 (Query): 전체 콘텐츠 시청 순위 조회 API와 완전히 동일한 파라미터 스펙(start_date, end_date, keyword, start_index, limit)을 사용합니다.

응답 구조 명세​

응답 스펙은 전체 콘텐츠 시청 순위 조회의 응답 구조와 완전히 동일합니다.

일별 통계 조회​

  • 기존 (v1): 미지원
  • 기존 (v2): GET /vod/statistics/summary-daily
  • 변경 (v3): GET /statistics/summary-daily
변경 사항

엔드포인트 경로에서 /vod 접두사가 제거되었습니다. 요청 쿼리 파라미터와 응답 구조는 v2 규격과 동일하게 유지됩니다.

요청 파라미터 및 응답 구조 상세

요청 쿼리 파라미터​

파라미터데이터 타입필수 여부설명
start_dateString필수조회 범위 시작 날짜 (YYYYMMDD)
end_dateString필수조회 범위 종료 날짜 (YYYYMMDD)

응답 구조 명세​

{
  "data": [
    {
      "startdate": "20231001",
      "enddate": "20231031",
      "total_transfer": 1024000,
      "max_traffic": 5000,
      "total_storage": 2048000,
      "max_storage": 2100000,
      "total_transcoding_size": 512000,
      "total_transcoding_count": 150,
      "total_visitor": 3500,
      "daily_data": [
        {
          "datetime": "20231001",
          "transfer": 30000,
          "traffic": 150,
          "storage": 2000000,
          "transcoding_size": 15000,
          "transcoding_count": 5,
          "visitor": 120
        }
      ]
    }
  ]
}