결제 매출 통계 조회

결제 매출 통계를 조회합니다.

요청

GET https://dashboard-api.gamepot.ntruss.com/v1/api/project/{projectId}/purchase/statistics?startDate={startDate}&endDate={endDate}&currency={currency}
항목 타입 필수 여부 설명 비고
projectId String O GamePot SDK의 projectId
startDate String X 결제 매출 통계 검색 시작일 YYYY-MM-DD
endDate String X 결제 매출 통계 검색 종료일 YYYY-MM-DD
currency String X 결제 매출 통계 통화 검색 (all…) ISO 4217규정을 따르고 있습니다.

쿼리로 startDate, endDate를 넣지 않으면 최근 30일간의 데이터를 조회합니다.

요청 헤더

헤더명 필수 여부 설명
x-api-key O GamePot에서 발급하는 인증 키
accept-language X 사용 언어

응답

필드명 타입 설명
status Int 결과값 (1: 성공)
totalCount Int 검색 결과 값 수
currencyList String 통화 리스트
ISO 4217규정을 따르고 있습니다.
date String 통계 날짜
count String 매출 통계 금액

예시

요청 예시


curl --request GET \
  --url https://dashboard-api.gamepot.ntruss.com/v1/api/project/12a0f2ff-xxxx-xxxx-xxxx-9c13ef02f5fs/purchase/statistics?startDate=2020-05-01&endDate=2020-06-01&currency=all \
  --header 'accept-language: ko' \
  --header 'x-api-key: 86dcgffae0641745432as02a8801ce5a5475f764fxxxxxxxxx'

응답 예시

"status": 1,
  "result": {
    "totalCount": 13,
    "currencyList": [
      "KRW",
      "USD"
    ],
    "edges": [
      {
        "node": {
          "date": "2020-05-01",
          "count": 0
        }
      },
      {
        "node": {
          "date": "2020-05-02",
          "count": 0
        }
      },

...

      {
        "node": {
          "date": "2020-05-13",
          "count": 4008857.31
        }
      }
    ]
  }
}

오류 코드

Gamepot Open API 요청시 발생하는 공통 에러코드입니다.

파라미터 설명
status 오류 코드(1: 성공, 실패시 Error code 참고)
message 오류 상세 설명
오류 코드 설명
-1 대시보드에 없는 키를 사용한 경우
-2 대시보드의 키와 헤더의 키가 다른경우
-3 대시보드에서 삭제한 키를 사용한 경우
-4 대시보드에서 미사용으로 처리된 키를 사용한 경우
-5 키가 만료된 경우
-6 프로젝트 아이디가 없는 경우
{
  "status": -6,
  "message": "projectId was wrong."
}

결제 매출 통계 조회 API 요청시 발생하는 에러코드입니다.

오류 코드 설명
-11 startDate 값의 포멧이 올바르지 않은 경우, YYYY-MM-DD 형태만 가능
-12 endDate 값의 포멧이 올바르지 않은 경우, YYYY-MM-DD 형태만 가능