플레이어 목록 조회

Prev Next
This content is currently unavailable in Ja - 日本語. You are viewing the default (Korean) version.

Classic/VPC 환경에서 이용 가능합니다.

게임 플레이어 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /v2/players

요청 헤더

GAMEPOT 3.0 API에서 공통으로 사용하는 헤더에 대한 정보는 GAMEPOT 3.0 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
filter String Required 필터링 조건
  • 응답 바디의 일부 필드를 기준으로 필터링
  • 전체 일치하는 값만 필터링
  • 조건이 없는 경우, 빈 값 {} 입력
  • <예시> {"player_id":"{플레이어아이디}"}, {"name":"{플레이어이름}"}, {"deleted":false}
sort String Optional 정렬 기준
  • {기준:방식} 형태로 입력
    • 기준: 응답 바디의 String 타입 필드
    • 방식: -1 | 1
      • -1: 내림차순
      • 1: 오름차순
  • <예시> {"createdAt":"-1"}: 생성 일시 기준 내림차순
option String Optional 추가 옵션: Option
  • <예시> {"offset":0,"per_page":20}: 첫 번째 항목부터 20개 표시

Option

Option에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
offset Integer Optional 조회 시작 오프셋
  • 0~N
per_page Integer Optional 페이지당 항목 수
  • 1~100

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://dashboard-api.gamepot.ntruss.com/v2/players?filter=%7B%22project_id%22%3A%2285ecd393-****-****-****-d85c321772da%22%7D&sort=%7B%22createdAt%22%3A%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
totalCount Integer - 전체 응답 수
players Array - 플레이어 목록: players

players

players에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
server_id String - 서버 아이디
deleted Boolean - 플레이어 삭제 여부
  • true | false
    • true: 삭제
    • false: 삭제 안됨
_id String - 객체 아이디
player_id String - 플레이어 아이디
project_id String - 프로젝트 아이디
user_id String - 사용자 아이디
createdAt String - 플레이어 생성 일시
  • ISO 8601 형식
id String - 플레이어 식별 아이디
ip String - 플레이어 IP 주소
level String - 플레이어 레벨
name String - 플레이어 이름
updatedAt String - 정보 수정 일시
  • ISO 8601 형식
userdata String - 사용자 데이터(Userdata)
참고

_id는 응답 결과에 노출될 수 있으나 서비스 사용에 영향을 주지 않는 필드입니다.

응답 상태 코드

GAMEPOT 3.0 API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 GAMEPOT 3.0 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "totalCount": 8,
  "players": [
    {
      "server_id": "s1",
      "deleted": false,
      "_id": "68b54440c3aa0413a1f937f9",
      "player_id": "p1",
      "project_id": "85ecd393-****-****-****-d85c321772da",
      "user_id": "c6a80a22-****-****-****-9829e42730b0",
      "createdAt": "2025-09-01T06:59:12.556Z",
      "id": "2*******0f",
      "ip": "**.**.*.***",
      "level": "1",
      "name": "n1",
      "updatedAt": "2025-09-01T06:59:12.556Z",
      "userdata": "u1"
    },
    ...
  ]
}