WhaTap Open API

Open API

수집 중인 모니터링 정보를 추출하여 별도로 활용하고자 하는 경우 Open API를 통해 해당 정보를 추출할 수 있는 기능을 제공합니다. 계정 API 토큰 및 프로젝트 API 토큰, 프로젝트 코드를 파라미터로 전달하여 수집된 정보를 획득할 수 있습니다.

구 버전의 Open API 문서는 다음 문서를 참조하세요.

Open API Token 확인

토큰은 계정 API 토큰과 프로젝트 API 토큰으로 구분됩니다. 계정 API 토큰은 프로젝트의 목록 정보를 취득하기 위한 용도로, 프로젝트 API 토큰은 프로젝트의 모니터링 정보를 취득하기 위한 용도로 활용합니다.

프로젝트 코드는 프로젝트 진입 시 브라우저 화면 상단의 윈도우 또는 탭 제목에 '[{프로젝트 코드}] Cloud Application Monitoring'와 같이 표시되는 정보를 통해 확인할 수 있습니다. API 토큰을 변경하려면 각 화면의 재발급 또는 토큰 재발급 버튼을 선택하세요.

구분	키	설정값	비교
헤더	`x-whatap-token`	API토큰	계정 API토큰
헤더	`x-whatap-token`	API토큰	프로젝트 API토큰
헤더	`x-whatap-pcode`	프로젝트 코드	화면 윈도우 또는 브라우저 탭 타이틀 확인

계정 토큰 확인하기

화면의 오른쪽 위에 프로필 아이콘을 선택하세요.
팝업 메뉴가 나타나면 계정 관리 버튼을 선택하세요.
화면을 아래로 스크롤해 API토큰 섹션으로 이동하세요.

프로젝트 토큰 확인하기

홈 화면에서 프로젝트를 선택하세요.
프로젝트 진입 후 왼쪽에 관리 > 프로젝트 관리 메뉴를 선택하세요.
API토큰 항목을 확인하세요.

프로젝트

프로젝트 목록 조회

프로젝트 목록을 조회하는 API입니다.

header Parameters

x-whatap-token

required

string

계정 API 토큰 {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
accountEmail	string 사용자 계정 이메일 주소
total	integer 프로젝트 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/projects"

Response samples

200

Content type

application/json

{"data": [{"groupName": "",
"projectCode": 35,
"projectName": "APM_TEST2",
"createTime": "2018-10-19T07:17:03.774",
"status": "subscribe",
"productType": "APM",
"platform": "JAVA",
"gatewayName": "LOCAL",
"apiToken": "5**********************R"
}
],
"accountEmail": "xxx@whatap.io",
"total": 6
}

프로젝트 정보 조회

애플리케이션 및 서버 상품의 프로젝트 정보를 조회하는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

One of

platform	string 애플리케이션 상품 플랫폼
createTime	string 프로젝트 생성 날짜
gatewayName	string 데이터 서버 지역
projectCode	number 프로젝트 코드
status	string Enum: "pending" "trial" "subscribe" "close_pending" "limited" "closed" "trial_limited" 프로젝트 상태
lastUpdatedTime	string 프로젝트 수정 날짜
name	string 프로젝트 이름
productType	string 애플리케이션 상품 유형

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/project"

Response samples

200

Content type

application/json

Example

Application

{"platform": "JAVA",
"createTime": "Tue Sep 18 08:34:27 GMT 2018",
"gatewayName": "Office-OTE",
"projectCode": 1234,
"status": "Subscribe",
"lastUpdatedTime": "Tue Sep 18 08:34:34 GMT 2018",
"name": "SEO_APM",
"productType": "APM"
}

프로젝트 멤버 목록 조회

프로젝트에 소속된 멤버 목록을 조회하는 API입니다.

path Parameters

projectCode

required

integer

프로젝트 코드

header Parameters

x-whatap-token

required

string

계정 API 토큰 {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
total	integer 프로젝트 멤버 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/project/{projectCode}/members"

Response samples

200

Content type

application/json

{"data": [{"email": "honggildong@whatap.io",
"name": "홍길동",
"desc": "",
"sms": "010XXXXXXX"
}
],
"totla": 8
}

그룹

그룹 목록 조회

사용자가 소속된 그룹 목록을 조회하는 API입니다.

header Parameters

x-whatap-token

required

string

계정 API 토큰 {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
total	integer 그룹 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/v2/json/groups"

Response samples

200

Content type

application/json

{"data": [{"groupName": "WHATAP APM",
"groupKey": "grp****ab123kskd*****q",
"description": "APM Group"
}
],
"total": 3
}

그룹 멤버 목록 조회

사용자가 소속된 그룹의 멤버 목록을 조회하는 API입니다.

path Parameters

groupKey

required

integer

그룹 고유 식별자(ID)

header Parameters

x-whatap-token

required

string

계정 API 토큰 {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

	Array of objects
total	integer 그룹 멤버 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/group/{groupKey}/members"

Response samples

200

Content type

application/json

{"data": [{"email": "honggildong@whatap.io",
"name": "홍길동",
"desc": "",
"sms": "010XXXXXXX"
}
],
"totla": 8
}

그룹에 포함된 프로젝트 조회

그룹에 포함된 프로젝트들의 메타정보를 조회하는 API입니다.

path Parameters

groupKey

required

integer

그룹 고유 식별자(ID)

header Parameters

x-whatap-token

required

string

계정 API 토큰 {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json

Array of objects

Array

projectCode	integer 프로젝트 코드
name	string 프로젝트 이름
status	string Enum: "pending" "trial" "subscribe" "close_pending" "limited" "closed" "trial_limited" 프로젝트 상태
productType	string 프로젝트의 상품 유형
platform	string 프로젝트의 상품 플랫폼
gatewayName	string 데이터 서버 지역

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \
  "https://api.whatap.io/open/api/json/group/{groupKey}/projects"

Response samples

200

Content type

application/json

{"data": [{"projectCode": 35,
"name": "APM_TEST2",
"status": "Subscribe",
"productType": "APM",
"platform": "JAVA",
"gatewayName": "LOCAL"
}
]
}

에이전트

에이전트 상태 및 호스트 IP 조회

프로젝트 내 에어전트의 상태 및 IP 주소를 조회하는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

Array of objects

Array

host_ip	string <ipv4> IP 주소
oname	string 에이전트 이름
active	boolean 에이전트 활성화 상태 여부

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/agents"

Response samples

200

Content type

application/json

{"data": [{"host_ip": "127.0.0.1",
"oname": "TC-29-96-8082",
"active": true
}
]
}

oid 목록 호출

사용자가 조회를 원하는 시간 동안 활성화된 에이전트 정보를 조회할 수 있는 API입니다. 조회 시간(stime, etime)은 하루로 제한되며, 시간 단위는 ms(millisecond, ms)입니다.

예시에서 작성된 샘플 코드 중 stime, etime 파라미터 값은 사용자 환경에 맞게 변경해 사용하세요. 파라미터 값은 다양한 포맷으로 변경해 요청할 수 있습니다.

1693475430087 (unix timestamp)
yyyyMMddHHmmss
yyyyMMddHHmm
MMddHHmmss
MMddHHmm

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Request Body schema: application/json
required

stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

Responses

Response Schema: application/json

stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
timestamp	integer <int64> 데이터 생성 시간(UNIX epoch time, millisecond)
	Array of objects

Request samples

Payload
curl

Content type

application/json

{"stime": 1690850183000,
"etime": 1693321200000
}

Response samples

200

Content type

application/json

{"stime": 1690850183000,
"etime": 1693321200000,
"timestamp": 1693388196965,
"data": [{"oid": 757639646,
"oname": "DBX-0-107-3306",
"alias": "",
"initial": "",
"otype": "database",
"subtype": "0",
"active": false,
"okind": 0,
"okindName": "",
"onode": 0,
"onodeName": "",
"ip": "",
"agent.version": "",
"cpuCores": 0
}
]
}

APM Spot 정보 조회

애플리케이션 모니터링 프로젝트의 에이전트 정보 및 관련 지표를 조회할 수 있는 API 목록을 안내합니다.

모든 정보 조회

애플리케이션 모니터링 프로젝트의 모든 정보를 조회하는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
act_agent	string 활성화 상태의 에이전트 수
inact_agent	string 비활성화 상태의 에이전트 수
host	string 호스트(HOST) 수
cpucore	string 호스트의 CPU 코어 수 합계
txcount	string 트랜잭션 갯수
tps	string TPS
user	string 액티브 사용자(5분)
actx	string 액티브 트랜잭션
rtime	string 평균 응답시간(ms)
cpu	string 평균 CPU 사용률(%)
threadpool_active	string 스레드풀 활성 스레드 수
threadpool_queue	string 스레드풀 큐잉 스레드 수
dbconn_total	string 전체 DB Connection 수
dbconn_act	string 활성(Active) 상태의 DB Connection 수
dbconn_idle	string 유휴(Idle) 상태의 DB Connection 수
act_method	string 활성 메소드(Method) 수
act_sql	string 활성 SQL 수
act_httpc	string 활성 HTTP Call 수
act_dbc	string 활성 데이터베이스 커넥션 수
act_socket	string 활성 소켓(Socket) 연결 수
apdex	string Apdex(Application Performance Index, 애플리케이션의 사용자 만족도)

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/json/spot"

Response samples

200

Content type

application/json

{"pcode": 8,
"act_agent": "6",
"inact_agent": "6",
"host": "1",
"cpucore": "2",
"txcount": "459",
"tps": "93.07",
"user": "1007",
"actx": "149",
"rtime": "1873",
"cpu": "29.35",
"threadpool_active": "0",
"threadpool_queue": "0",
"dbconn_total": "600.0",
"dbconn_act": "239.0",
"dbconn_idle": "361.0",
"act_method": "51",
"act_sql": "24",
"act_httpc": "64",
"act_dbc": "10",
"act_socket": "0",
"apdex": "0.9871"
}

활성화 상태의 에이전트 수 조회

애플리케이션 모니터링 프로젝트에서 활성화 상태의 에이전트 수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

활성화 상태의 에이전트 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/act_agent"

Response samples

200

Content type

text/plain

비활성화 상태의 에이전트 수 조회

애플리케이션 모니터링 프로젝트에서 비활성화 상태의 에이전트 수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

비활성화 상태의 에이전트 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/inact_agent"

Response samples

200

Content type

text/plain

호스트(HOST) 수

애플리케이션 모니터링 프로젝트와 연결된 호스트(HOST) 수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

호스트(HOST) 개수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/host"

Response samples

200

Content type

text/plain

호스트의 CPU 코어 합

애플리케이션 모니터링 프로젝트와 연결된 호스트(HOST)의 CPU 코어 합계를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

CPU 코어 개수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/cpucore"

Response samples

200

Content type

text/plain

트랜잭션 개수

애플리케이션 모니터링 프로젝트에서 트랜잭션 개수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

트랜잭션 개수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/txcount"

Response samples

200

Content type

text/plain

TPS

애플리케이션 모니터링 프로젝트에서 초당 처리된 트랜잭션 건수(Transaction per second, TPS)를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

number <float>

초당 처리된 트랜잭션 건수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/tps"

Response samples

200

Content type

text/plain

92.03

액티브 사용자(5분)

애플리케이션 모니터링 프로젝트에서 최근 5분 이내에 트랜잭션을 발생시킨 사용자를 측정한 동시 접속 사용자를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

5분 동안 실시간 사용자 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/user"

Response samples

200

Content type

text/plain

액티브 트랜잭션

애플리케이션 모니터링 프로젝트에서 액티브 트랜잭션 수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

액티브 트랜잭션 수

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/actx"

Response samples

200

Content type

text/plain

평균 응답시간

애플리케이션 모니터링 프로젝트에서 평균 응답시간을 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

integer

평균 응답시간

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/rtime"

Response samples

200

Content type

text/plain

평균 CPU 사용률

애플리케이션 모니터링 프로젝트에서 평균 CPU 사용률을 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

number <float>

평균 CPU 사용률

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/cpu"

Response samples

200

Content type

text/plain

9.26

Apdex

애플리케이션 모니터링 프로젝트에서 Apdex(Application Performance Index, 애플리케이션의 사용자 만족도)를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

number <float>

Apdex

Request samples

curl

curl -L \
  -w "\n" \
  -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
  -H "x-whatap-pcode: {{projectCode}}" \
  "https://api.whatap.io/open/api/apdex"

Response samples

200

Content type

text/plain

0.9871

APM 통계 데이터 조회

애플리케이션 모니터링 프로젝트의 통계 데이터를 조회할 수 있는 API 목록을 안내합니다.

Exception

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 Exception 처리된 내역을 조회할 수 있는 API입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects
total	integer 전체 예외 레코드 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/exception/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"oids": "[-1459620666]",
"time": 1535557500000,
"classHash": -1811136020,
"count": 14,
"service": "/account/delete/dept/daegu",
"class": "java.sql.SQLException(0)",
"serviceHash": 1900616259,
"snapSeq": "6068699991557528332",
"msg": "Sql Exception"
}
],
"total": 2063
}

HTTP 외부 호출

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 HTTP 외부 호출 내역을 조회할 수 있는 API입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects
total	integer 총 HTTP 연결 레코드 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/httpc/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"Sum": 22628,
"Port": 10002,
"Url": "/remote/account/save/employee/kwangju",
"Host": "127.0.0.1",
"Max": 1815,
"Stdev": "247.95",
"Actived": 0,
"Avg": 1131,
"HostHash": -675813464,
"Min": 1002,
"Error": 0,
"Total": 20,
"UrlHash": -243814510
}
],
"total": 4923
}

HTTP 외부 호출 필터링

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 HTTP 외부 호출 내역을 호스트의 주소와 포트 번호를 기준으로 필터링해 조회할 수 있는 API입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
host required	string 필터링할 호스트 주소
port required	string 필터링할 호스트 포트 번호

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects
total	integer 총 HTTP 연결 레코드 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/httpc/{stime}/{etime}/filter/host/{host}/port/{port}"

Response samples

200

Content type

application/json

{"records": [{"Service": "/sales/remove/unit/kwangju",
"Host": "127.0.0.1",
"HostHash": -675813464,
"Avg": 1080,
"Error": 0,
"Sum": 2411644,
"Port": 10007,
"Service_hash": -1003301916,
"Url": "/remote/account/save/employee/seoul",
"Max": 2442,
"Stdev": "159.01",
"UrlHash": 180997672,
"Total": 2233,
"Min": 1001
},
{"Service": "/product/delete/employee/daejun",
"Host": "127.0.0.1",
"HostHash": -675813464,
"Avg": 1085,
"Error": 0,
"Sum": 2075036,
"Port": 10007,
"Service_hash": 2100205994,
"Url": "/remote/account/save/employee/pusan",
"Max": 2462,
"Stdev": "173.06",
"UrlHash": -924053750,
"Total": 1911,
"Min": 1001
}
],
"total": 1080
}

SQL

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 SQL 문을 조회할 수 있는 API입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects
total	integer 총 SQL 쿼리 레코드 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/sql/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"time_max": 4164,
"dbcHash": 450678784,
"db": "jdbc:mysql://localhost:3306,localhost:3310/fake",
"time_min": 0,
"fetch_count": 0,
"hash": 796628118,
"fetch_time": 0,
"sql_crud": 0,
"count_total": 5224,
"count_error": 0,
"sql": "update table set x=# where key=#",
"time_sum": 581391,
"time_avg": 111,
"time_std": "240.79",
"count_actived": 0
}
],
"total": 130
}

Client IP

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 원격 클라이언트 IP를 조회할 수 있는 API입니다. 와탭은 클라이언트와 관련한 정보를 기본 저장합니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects
total	integer 총 원격 클라이언트 IP 레코드 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/remote/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"count": 86,
"city": "Winnipeg",
"country": "CA (CANADA)",
"ip": "140.193.83.68"
}
],
"total": 1000
}

트랜잭션

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 발생한 트랜잭션 내역을 조회할 수 있는 API입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects
total	integer 총 트랜잭션 레코드 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/transaction/{stime}/{etime}"

Response samples

200

Content type

application/json

{"records": [{"apdex_tolerated": 98,
"apdex_satisfied": 279,
"apdex": 0.830379746835443,
"time_max": 44735,
"sql_fetch_time": 363,
"sql_time": 2628663,
"count": 10743,
"error": 29,
"sql_count": 22635,
"hash": -1485863373,
"sql_fetch": 6741607,
"httpc_avg": 1084,
"cpu_avg": 0,
"time_sum": 19911778,
"time_avg": 1853,
"httpc_count": 7072,
"service": "/account/save/employee/seoul",
"mem_avg": 0
}
],
"total": 1080
}

Heap 사용량 - 통계 평균값

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 Heap 사용량에 대한 통계 평균값을 조회할 수 있는 API입니다. 조회 시간은 한 시간 이내로 제한하며, 밀리초(millisecond, ms) 단위입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
timeMerge	string 데이터 집계 방식(avg 또는 max)
unit	string Heap 사용량 단위(예, byte)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/heap_use/{stime}/{etime}/avg"

Response samples

200

Content type

application/json

{"pcode": 5490,
"stime": 1677747600000,
"etime": 1677749594269,
"timeMerge": "avg",
"unit": "byte",
"data": [{"oid": -1143239575,
"oname": "demo-8101",
"heap_use": "36121554.72"
},
{"oid": -857948929,
"oname": "demo-8105",
"heap_use": "37498925.139"
}
]
}

Heap 사용량 - 통계 최댓값

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 Heap 사용량에 대한 통계 최댓값을 조회할 수 있는 API입니다. 조회 시간은 한 시간 이내로 제한하며, 밀리초(millisecond, ms) 단위입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
timeMerge	string 데이터 집계 방식(avg 또는 max)
unit	string Heap 사용량 단위(예, byte)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/heap_use/{stime}/{etime}/max"

Response samples

200

Content type

application/json

{"pcode": 5490,
"stime": 1677747600000,
"etime": 1677749594269,
"timeMerge": "max",
"unit": "byte",
"data": [{"oid": -1143239575,
"oname": "demo-8101",
"heap_use": "36121554.72"
},
{"oid": -857948929,
"oname": "demo-8105",
"heap_use": "37498925.139"
}
]
}

에이전트 데이터 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 전체 에이전트의 데이터를 조회할 수 있는 API입니다.

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 조회할 수 있는 지표
stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 조회할 수 있는 지표
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
interval	integer 데이터 포인트 간격(초)
timeMerge	string 데이터 집계 방식(sum)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objects": [{"oname": "8080",
"oid": -1234257485,
"series": [[1536050100000,
95.2
],
[1536050400000,
85.3
],
[1536050700000,
91.43
]
]
},
{"oname": "TC-29-96-8082",
"oid": 1482741919,
"series": [[1536050100000,
98.11
],
[1536050400000,
81.44
],
[1536050700000,
90.05
]
]
}
]
}

에이전트 평균 데이터 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 전체 에이전트의 평균 데이터를 조회할 수 있는 API입니다.

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 조회할 수 있는 지표
stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 조회할 수 있는 지표
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
interval	integer 데이터 포인트 간격(초)
timeMerge	string 데이터 집계 방식(sum)
objectMerge	string 데이터 병합 방식(avg)
	Array of items

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/avg"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objectMerge": "avg",
"series": [[1536050100000,
122.86
],
[1536050400000,
99.26
],
[1536050700000,
109.68
]
]
}

지정 에이전트 데이터 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 지정한 에이전트(oids)의 스레드 수 데이터를 조회할 수 있는 API입니다. 에이전트(oids)는 쉼표(,)를 구분자로 여러 개 지정할 수 있습니다.

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 조회할 수 있는 지표
stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
oids required	integer <int32> 에이전트 고유 식별자(ID), 쉼표(,)를 구분자로 여러 개 입력 가능

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller" 조회할 수 있는 지표
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
interval	integer 데이터 포인트 간격(초)
timeMerge	string 데이터 집계 방식(sum)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/{oids}"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objects": [{"oname": "8080",
"oid": -1234257485,
"series": [[1536050100000,
95.2
],
[1536050400000,
85.3
],
[1536050700000,
91.43
]
]
},
{"oname": "TC-29-96-8082",
"oid": 1482741919,
"series": [[1536050100000,
98.11
],
[1536050400000,
81.44
],
[1536050700000,
90.05
]
]
}
]
}

지정 에이전트 평균 데이터 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 지정한 에이전트(oids)의 평균 데이터를 조회할 수 있는 API입니다. 에이전트(oids)는 쉼표(,)를 구분자로 여러 개 지정할 수 있습니다.

path Parameters

metric_type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 조회할 수 있는 지표
stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
type	string Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" 조회할 수 있는 지표
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
interval	integer 데이터 포인트 간격(초)
timeMerge	string 데이터 집계 방식(sum)
objectMerge	string 데이터 병합 방식(avg)
	Array of items

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/avg/{oids}"

Response samples

200

Content type

application/json

{"pcode": 1234570141,
"type": "metric_type",
"stime": 1536050100000,
"etime": 1536050700000,
"interval": 300,
"timeMerge": "sum",
"objectMerge": "avg",
"series": [[1536050100000,
117.49
],
[1536050400000,
100.26
],
[1536050700000,
120.2
]
]
}

5분 단위 액티브 사용자 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 5분 단위의 동시 접속 사용자를 조회할 수 있는 API입니다. 동시 접속 사용자는 최근 5분 이내에 트랜잭션을 발생시킨 사용자를 측정한 값입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of items
pcode	integer 프로젝트 코드
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
total	integer 총 방문자 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_5m/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [[1554444005000,
12
],
[1554444010000,
12
]
],
"pcode": 3000000079,
"stime": 1554444000000,
"etime": 1554444300000,
"total": 59
}

1시간 단위 액티브 사용자 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 1시간 단위의 동시 접속 사용자를 조회할 수 있는 API입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of items
pcode	integer 프로젝트 코드
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
total	integer data 배열의 총 개수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_h/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [[1554444000000,
18
],
[1554444010000,
16
]
],
"pcode": 3000000079,
"stime": 1554444000000,
"etime": 1554454800000,
"total": 59
}

1일 단위 액티브 사용자 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 1일 단위의 동시 접속 사용자를 조회할 수 있는 API입니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of items
pcode	integer 프로젝트 코드
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
total	integer 총 방문자 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_d/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [[1554163200000,
1007
],
[1554249600000,
1007
],
[1554336000000,
1007
]
],
"pcode": 3000000079,
"stime": 1554163200000,
"etime": 1554422400000,
"total": 3
}

1개월 단위 액티브 사용자 조회

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 1개월 단위의 동시 접속 사용자를 조회할 수 있는 API입니다. 1개월간 집계된 고유 사용자 통계로 etime은 stime을 기준으로 365일을 초과할 수 없습니다.

path Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects 각 월별 사용자 통계 데이터
pcode	integer 프로젝트 코드
stime	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
sdate	string 조회 시작 시간의 문자열 표현
edate	string 조회 종료 시간의 문자열 표현
total	integer 총 방문자 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/visitor_m/{stime}/{etime}"

Response samples

200

Content type

application/json

{"data": [{"stime": 1535760000000,
"etime": 1538352000000,
"sdate": "Sat Sep 01 00:00:00 GMT 2018",
"edate": "Mon Oct 01 00:00:00 GMT 2018",
"mau": 1007
},
{"stime": 1538352000000,
"etime": 1541030400000,
"sdate": "Mon Oct 01 00:00:00 GMT 2018",
"edate": "Thu Nov 01 00:00:00 GMT 2018",
"mau": 1007
}
],
"pcode": 1234570141,
"stime": 1535760000000,
"etime": 1541030400000,
"sdate": "Sat Sep 01 00:00:00 GMT 2018",
"edate": "Thu Nov 01 00:00:00 GMT 2018",
"total": 2
}

호출 통계 필터링

프로젝트 간 트랜잭션 호출 통계 또는 트랜잭션 도메인 호출 통계를 필터링해 조회할 수 있습니다.

filterkey: 조회 조건 키 (caller_pcode, caller_spec (버전), caller_url, spec (버전), url)
filterval: 조회 조건 (filterkey가 caller_url 또는 url인 경우 base64로 인코딩)

path Parameters

metric_type	string Enum: "tx_caller" "tx_domain" 조회할 수 있는 지표
stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
filterkey required	string Enum: "caller_pcode" "caller_spec" "caller_url" "spec" "url" 조회 조건 키
filterval required	string 조회 조건 (`filterkey가` `caller_url` 또는 `url`인 경우 base64로 인코딩)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/filter/{filterkey}/{filtereval}"

지정 에이전트 호출 통계 필터링

지정한 에이전트를 기준으로 프로젝트 간 트랜잭션 호출 통계 또는 트랜잭션 도메인 호출 통계를 필터링해 조회할 수 있습니다.

filterkey: 조회 조건 키 (caller_pcode, caller_spec (버전), caller_url, spec (버전), url)
filterval: 조회 조건 (filterkey가 caller_url 또는 url인 경우 base64로 인코딩)

path Parameters

metric_type	string Enum: "tx_caller" "tx_domain" 조회할 수 있는 지표
stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
oids required	integer <int32> 에이전트 고유 식별자(ID), 쉼표(,)를 구분자로 여러 개 입력 가능
filterkey required	string Enum: "caller_pcode" "caller_spec" "caller_url" "spec" "url" 조회 조건 키
filterval required	string 조회 조건 (`filterkey가` `caller_url` 또는 `url`인 경우 base64로 인코딩)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/{metric_type}/{stime}/{etime}/{oids}/filter/{filterkey}/{filtereval}"

TPS

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 TPS(Transaction Per Second) 데이터를 조회할 수 있는 API입니다.

query Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
timeMerge required	string Value: "avg" 데이터 집계 방식

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

number <float>

TPS 수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/raw/tag/app_counter/tps?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

text/plain

66.0

평균 응답 시간

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 평균 응답 시간을 조회할 수 있는 API입니다.

query Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
timeMerge required	string Value: "avg" 데이터 집계 방식

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

number

평균 응답 시간

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/raw/tag/app_counter/resp_time?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

text/plain

평균 CPU 사용률

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 평균 CPU 사용률을 조회할 수 있는 API입니다.

query Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
timeMerge required	string Value: "avg" 데이터 집계 방식

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: text/plain

number

평균 CPU 사용률

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/raw/tag/app_host_resource/cpu?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

text/plain

11.50

데이터 소스별 DB Connection 수

애플리케이션 모니터링 프로젝트에서 설정한 시간 동안 데이터 소스별 DB Connection 수를 조회할 수 있는 API입니다.

query Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
timeMerge required	string Value: "avg" 데이터 집계 방식

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
time	integer <int64> 조회 시간
	Array of objects (ConnectionDetail)

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/tag/db_pool_detail/dbconn?stime={stime}&etime={etime}&timeMerge={timeMerge}"

Response samples

200

Content type

application/json

{"pcode": 35,
"time": 1554163200000,
"dbc_total": [{"oid": -963710734,
"oname": "TC-29-96-8082",
"databaseUrl": "jdbc:db:virtual",
"active": 49,
"idle": 51,
"total": 100
}
]
}

데이터 소스별 DB Connection 수 - 단기 조회

애플리케이션 모니터링 프로젝트에서 종료 시간을 기준으로 데이터 소스별 DB Connection 수를 조회할 수 있는 API입니다.

query Parameters

etime

required

integer <int64>

조회 종료 시간(UNIX epoch time, millisecond)

header Parameters

x-whatap-token required	string 계정 API 토큰 {{ACCOUNT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
time	integer <int64> 조회 시간
	Array of objects (ConnectionDetail)

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/tag/db_pool_detail/dbconn?etime={etime}"

Response samples

200

Content type

application/json

{"pcode": 17,
"time": 1667467012037,
"dbc_total": [{"oid": -959062357,
"oname": "TC-0-1-8087",
"databaseUrl": "jdbc:db:virtual",
"active": 63,
"idle": 37,
"total": 100
},
{"oid": -1311576515,
"oname": "TC-0-1-8086",
"databaseUrl": "jdbc:db:virtual",
"active": 10,
"idle": 90,
"total": 100
}
]
}

IP 기반 트랜잭션 검색

사용자가 지정한 시작 시간(stime)으로부터 1시간 동안, 특정 IP가 요청한 트랜잭션을 호출 건수 많은 순으로 정렬하여 최대 100건의 URL 목록을 전달하는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Request Body schema: application/json
required

type	string
path	string
pcode	string 프로젝트 코드
	object

Responses

Response Schema: application/json

elapsed	number 시작 시간(`stime`) 기준으로부터 경과 시간
count	number HTTP 호출 건수
url	string 클라이언트가 요청한 트랜잭션 이름

Request samples

Payload
curl

Content type

application/json

{"type": "profiles",
"path": "/filter/search",
"pcode": "12345",
"params": {"stime": 1690850183000,
"filter": {"ip": "10.11.12.13"
}
}
}

Response samples

200

Content type

application/json

{"elapsed": 0,
"count": 0,
"url": "string"
}

Server Spot 정보 조회

서버 모니터링 프로젝트의 에이전트 정보 및 관련 지표를 조회할 수 있는 API 목록을 안내합니다.

활성화 상태의 에이전트 수 조회

서버 모니터링 프로젝트에서 활성화 상태의 에이전트 수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pname	string 프로젝트 이름
values	string 개수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/act_agent"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "57.0"
}

비활성화 상태의 에이전트 수 조회

서버 모니터링 프로젝트에서 비활성화 상태의 에이전트 수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pname	string 프로젝트 이름
values	string 개수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/inact_agent"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "4.0"
}

호스트(HOST) 수

서버 모니터링 프로젝트와 연결된 호스트(HOST) 수를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pname	string 프로젝트 이름
values	string 개수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/host"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "57.0"
}

호스트의 CPU 코어 합

서버 모니터링 프로젝트와 연결된 호스트(HOST)의 CPU 코어 합계를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pname	string 프로젝트 이름
values	string 개수

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/cpucore"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": "108.0"
}

CPU 사용률

서버 모니터링 프로젝트와 연결된 호스트(HOST)의 CPU 사용률을 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
pname	string 프로젝트 이름
timezone	integer 타임존
regionName	string 데이터 서버 지역
	object 서버별 CPU 사용률(%)
language	string 경고 알림 언어

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_cpu"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": {"mysql-official-demo-03": 0.9009018,
"php-official-demo": 1.6949158,
"python-demo-attacker": 0.50099945,
"virtual-java-agent": 55.08919
},
"language": "en"
}

디스크 IOPS 합계

서버 모니터링 프로젝트와 연결된 호스트(HOST)의 디스크 IOPS 합계를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
pname	string 프로젝트 이름
timezone	integer 타임존
regionName	string 데이터 서버 지역
	object
language	string 경고 알림 언어

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_disk_iops"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": {"mysql-official-demo-03": {"bps": 8208.67,
"iops": 1.402849
},
"php-official-demo": {"bps": 3951.273,
"iops": 0.771733
},
"python-demo-attacker": {"bps": 7376.34,
"iops": 1.00048
},
"virtual-java-agent": {"bps": 6563.1836,
"iops": 0.40058494
}
},
"language": "en"
}

네트워크 트래픽(IN/OUT) 합산

서버 모니터링 프로젝트와 연결된 호스트(HOST)의 네트워크 트래픽(IN/OUT) 합산을 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
pname	string 프로젝트 이름
timezone	integer 타임존
regionName	string 데이터 서버 지역
	object
language	string 경고 알림 언어

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_net_traffic"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": {"mysql-official-demo-03": 128204.76878652698,
"python-demo-attacker": 16231.465016029671,
"virtual-java-agent": 10820618.160992496
},
"language": "en"
}

프로세스 현황

서버 모니터링 프로젝트와 연결된 호스트(HOST)의 프로세스 현황을 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pname	string 프로젝트 이름
	object
language	string 경고 알림 언어

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/infra_proc"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": {"s-p-gtw-03": [{"memoryBytes": 1274269696,
"bps": 819.2,
"cmd1": "java",
"cpu": 2.8507125
},
{"memoryBytes": 2895872,
"bps": 0,
"cmd1": "rsyslogd",
"cpu": 0
}
],
"t-a-yrd-01": [{"memoryBytes": 2583621632,
"bps": 1175961.5,
"cmd1": "java",
"cpu": 10.621243
}
]
}
}

서버 목록

서버 모니터링 프로젝트의 서버 목록을 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
pname	string 프로젝트 이름
timezone	integer 타임존
regionName	string 데이터 서버 지역
	Array of objects
language	string 경고 알림 언어

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/sm_servers"

Response samples

200

Content type

application/json

{"pcode": 29763,
"pname": "Server Monitoring Demo",
"timezone": 9,
"regionName": "LOCAL",
"values": [{"os.status": "warning",
"oname": "php-official-demo",
"os.name": "linux",
"oid": -1413588424,
"isActive": true
},
{"os.status": "ok",
"oname": "dotnet-official-demo",
"os.name": "windows",
"oid": -1755389652,
"isActive": true
},
{"os.status": "ok",
"oname": "mysql-official-demo-02",
"os.name": "linux",
"oid": -1816982090,
"isActive": true
}
],
"language": "en"
}

서버 모니터링 상세

서버 모니터링 프로젝트의 각 서버별 상세 정보를 조회할 수 있는 API입니다.

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/sm"

Response samples

200

Content type

application/json

{"pname": "LOCAL_INFRA",
"values": {"servers": [{"public_ip": "192.168.0.1",
"os_cpuvendor": "Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz",
"agent_created": "49572130779",
"ip": "127.0.0.1,10.128.0.1",
"os_arch": "amd64",
"actTime": 1570672662216,
"cpu_cores": "1",
"oid": -1359816680,
"isActive": true,
"version": "1.2.5",
"tags": ["gateway",
"python",
"network:10.0.0.0/8",
"@PRX"
],
"inactTime": 0,
"oname": "h-db-prx-01",
"os_name": "linux",
"startTime": 1570672662000,
"os_memory": "2088476672",
"os_status": "ok",
"snapshot": {"disk": {"/boot": {"writeIops": 0,
"fileSystem": "ext4",
"mountPoint": "/boot",
"queueLength": 0,
"usedSpace": 58863616,
"blksize": 4096,
"freeSpace": 841175040,
"display": true,
"count": 1,
"readBps": 0,
"totalSpace": 966778880,
"ioPercent": 0,
"mountOption": "rw,relatime",
"deviceId": "/dev/sda1",
"usedPercent": 6.540122985839844,
"freePercent": 93.45987701416016,
"writeBps": 0,
"readIops": 0
},
"/home": {"writeIops": 0,
"fileSystem": "ext4",
"mountPoint": "/home",
"queueLength": 0,
"usedSpace": 1670574080,
"blksize": 4096,
"freeSpace": 69533446144,
"display": true,
"count": 1,
"readBps": 0,
"totalSpace": 75039498240,
"ioPercent": 0,
"mountOption": "rw,relatime",
"deviceId": "/dev/sda3",
"usedPercent": 2.3461761474609375,
"freePercent": 97.65382385253906,
"writeBps": 0,
"readIops": 0
},
"/": {"writeIops": 0,
"fileSystem": "ext4",
"mountPoint": "/",
"queueLength": 0,
"usedSpace": 5079060480,
"blksize": 4096,
"freeSpace": 22798901248,
"display": true,
"count": 1,
"readBps": 0,
"totalSpace": 29394726912,
"ioPercent": 0,
"mountOption": "rw,relatime",
"deviceId": "/dev/sda2",
"usedPercent": 18.218902587890625,
"freePercent": 81.78109741210938,
"writeBps": 0,
"readIops": 0
}
},
"memory": {"shared": 21590016,
"swapused": 0,
"buffers": 182550528,
"available": 1746370560,
"swaptotal": 0,
"used": 342106112,
"pused": 16.380653381347656,
"slab": 85729280,
"total": 2088476672,
"sunreclaim": 23261184,
"cached": 521756672,
"pavailable": 83.61934661865234,
"pagefaults": 0,
"sreclaimable": 62468096,
"free": 1167208448,
"swappused": 0
},
"cpu": {"softirq": 0,
"usr": 0,
"idle": 100,
"steal": 0,
"irq": 0,
"load5": 0,
"iowait": 0,
"sys": 0,
"nice": 0,
"load1": 0,
"load15": 0
},
"open_filedescriptors": 249,
"netstat": {"established": 1,
"syn_sent": 1,
"syn_recv": 0,
"closing": 0,
"time_wait": 19,
"last_ack": 0,
"fin_wait1": 0,
"close_wait": 0,
"fin_wait2": 0,
"listen": 3,
"unknown": 0
},
"uptime": 16313689,
"network": {"lo": {"errorOut": 0,
"packetOut": 0.3991734786600438,
"trafficIn": 281.0181289766709,
"trafficOut": 281.0181289766709,
"hwAddr": "",
"errorIn": 0,
"ip": "127.0.0.1",
"count": 1,
"droppedIn": 0,
"droppedOut": 0,
"packetIn": 0.3991734786600438,
"desc": "lo"
},
"eth0": {"errorOut": 0,
"packetOut": 8.1830563125309,
"trafficIn": 11314.173079140282,
"trafficOut": 19447.731880317337,
"hwAddr": "00:1d:d8:b7:87:18",
"errorIn": 0,
"ip": "10.128.112.133",
"count": 1,
"droppedIn": 0,
"droppedOut": 0,
"packetIn": 24.549168937592693,
"desc": "eth0"
}
}
}
}
],
"max": {"disk": {"writeIops": 240.9893,
"usedPercent": 94.38699,
"freePercent": 100,
"usedSpace": 2464956810000,
"freeSpace": 0,
"writeBps": 2917852,
"readBps": 118646.15,
"readIops": 75.80727,
"totalSpace": 9223372000000000000,
"ioPercent": 100,
"freespace": 158926471000
},
"nic": {"errorOut": 0,
"packetOut": 2175.8743,
"trafficIn": 4856648,
"trafficOut": 2503208.8,
"errorIn": 1,
"droppedIn": 1,
"droppedOut": 0,
"packetIn": 2175.8743
},
"compound_eye_traffic": 1000000000
},
"count": {"total": 14,
"paused": 0,
"inactive": 0,
"warning": 1,
"ok": 13,
"close": 0,
"fatal": 0
},
"tags": { }
}
}

Server 통계 데이터 조회

서버 모니터링 프로젝트의 통계 데이터를 조회할 수 있는 API 목록을 안내합니다.

서버 통계 상세

서버 모니터링 프로젝트의 통계 데이터를 조회할 수 있는 API입니다. 조회 시간은 한 시간 이내로 제한하며, 밀리초(millisecond, ms) 단위입니다.

filter: 기본값은 m5이며, 시간 범위 내에 5분 통계를 조회하려면 m5, 5초 통계는 s5, 1시간 통계는 h1을 입력하세요.
oid: 특정 에이전트를 지정해 조회할 경우 추가하세요.

oid 외 다른 파라미터는 적용할 수 없습니다.

query Parameters

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
filter required	string Enum: "m5" "s5" "h1"
oid required	integer <int32> 에이전트 고유 식별자(ID)

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

Array of objects

Array

oid	integer 에이전트 고유 식별자(ID)
	Array of objects

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/json/stat/sm_stat?{stime}&{etime}&{filter}&{oid}"

Response samples

200

Content type

application/json

{"servers": [{"oid": -1030311093,
"timeData": [{"usedPercent": 69.1,
"trafficIn": 12113.57,
"trafficOut": 24781.08,
"cpu": 4.08,
"memory_swappused": 15.41,
"time": 1572341400000,
"memory_pused": 47.6,
"ioPercent": 0.26
},
{"usedPercent": 69.1,
"trafficIn": 12183.97,
"trafficOut": 25600.59,
"cpu": 7.89,
"memory_swappused": 15.5,
"time": 1572341700000,
"memory_pused": 47.79,
"ioPercent": 0.22
}
]
}
]
}

Database 파라미터 조회

데이버베이스의 파라미터 관련 사항을 조회할 수 있습니다.

파라미터 변경 사항 조회

데이버베이스의 파라미터 변경 사항을 조회할 수 있습니다.

query Parameters

oid required	integer <int32> 에이전트 고유 식별자(ID)
baeTime required	string <yyyyMMdd> 기준 시간
comparisonTime required	string <yyyyMMdd> 비교 시간

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: applciation/json

	Array of objects (UnmatchedKey) 기준 시간과 비교 시간에서 일치하지 않는 키와 그 값들
	Array of objects (MatchedParameter) 기준 시간에서의 파라미터 목록
	Array of objects (MatchedParameter) 비교 시간에서의 파라미터 목록

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/db/database_params?oid={oid}&baseTime={baseTime}&comparisonTime={comparisonTime}"

Response samples

200

Content type

applciation/json

{"unmatchedKeys": [{"key": "Innodb_buffer_pool_load_status(stat)",
"value": {"baseTime": "Buffer pool(s) load completed at 230818  2:54:51",
"comparisonTime": "Buffer pool(s) load completed at 230810  6:05:50"
}
},
{"key": "Max_used_connections_time(stat)",
"value": {"baseTime": "2023-08-18 23:54:51",
"comparisonTime": "2023-08-10 06:05:51"
}
}
],
"baseTime": [{"key": "activate_all_roles_on_login",
"value": "OFF"
},
{"key": "admin_address",
"value": ""
}
],
"comparisonTime": [{"key": "activate_all_roles_on_login",
"value": "OFF"
},
{"key": "admin_address",
"value": ""
}
]
}

Database SQL 조회

데이버베이스의 SQL 관련 사항을 조회할 수 있습니다.

SQL 통계 TopN

설정한 시간 동안 가장 많이 이용된 SQL 통계 정보를 조회할 수 있습니다.

query Parameters

oids required	integer <int32> 에이전트 고유 식별자(ID), 쉼표(,)를 구분자로 여러 개 입력 가능
period required	string Enum: "day" "weak" 조회 기간
date required	string <yyyyMMdd> 기준 시간
topN	number <1 -1000> Default: 10 상위 건수
order	string Default: "sql_execute_cnt" Enum: "sql_execute_cnt" "sql_elapse" "sql_elapse_max" 정렬 순서
category	string Default: "ALL" Enum: "ALL" "DB" "HOST" "USER" 카테고리를 `USER`로 선택하면 사용자 기준으로 SQL 통계 데이터 응답
nameInCategory	string 파라미터로 `category`를 선택하면 추가

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Responses

Response Schema: application/json

	Array of objects (SqlRecord)
topN	integer 요청된 TopN 값
total	integer 전체 기록된 SQL 목록 수
retrievedStartTime	integer <int64> 조회 기간의 시작 시간
retrievedEndTime	integer <int64> 조회 기간의 종료 시간

Request samples

curl

curl -L \
-w "\n" \
-H "x-whatap-token: {{PROJECT_API_TOKEN}}" \
-H "x-whatap-pcode: {{projectCode}}" \
"https://api.whatap.io/open/api/json/db/statistics/sql?oids={oids}&period={period}&date={date}"

Response samples

200

Content type

application/json

{"records": [{"sql_execute_cnt": 33863,
"sql_elapse": 643,
"sqlHash": 1559625025,
"sql_elapse_max": 5,
"onames": "DBX-0-102-3306,DBX-0-162-3306",
"user": "kwlee",
"sql": "select /* WhaTap6D#5 */ * from information_schema.processlist where command<>'#'"
},
{"sql_execute_cnt": 28387,
"sql_elapse": 0,
"sqlHash": -499643965,
"sql_elapse_max": 0,
"onames": "DBX-0-107-3306",
"user": "whatap",
"sql": "select id,user,host,db,command,time,state,info,time_ms,stage,max_stage,progress, memory_used,max_memory_used,examined_rows,query_id,tid from information_schema.processlist where command<>'#' and command<>'#'"
}
],
"topN": 10,
"total": 129,
"retrievedStartTime": 1692921600000,
"retrievedEndTime": 1693007999000
}

MXQL Open API 사용 안내

MXQL을 사용하는 방법은 다음과 같습니다.

직접 MXQL 쿼리를 작성해서 데이터를 조회하는 방법
다음 문서에서와 같이 'SaaS 서비스에서 제공하는 사전에 정의된 MXQL 쿼리 목록'으로 데이터를 조회하는 방법

따라서 각각의 경우에 사용하는 API의 path가 달라집니다.

MXQL 활용 방법	API
직접 MXQL 쿼리를 작성하는 경우	MXQL text API
'SaaS 서비스에서 제공하는 사전에 정의된 MXQL 쿼리 목록'을 사용하는 경우(다음 문서 참조)	MXQL path API

Open API 호출 시 헤더에 포함하는 내용은 다음과 같습니다.

구분	키	설정 값	비고
헤더	x-whatap-token	API 토큰 `{{PROJECT API TOKEN}}`	프로젝트 API토큰: 프로젝트 선택 > 관리 > 프로젝트 관리 > API토큰
헤더	x-whatap-pcode	프로젝트 코드 `{{projectCode}}`	프로젝트 코드: 프로젝트 선택 > 관리 > 프로젝트 관리 > 프로젝트 코드

MXQL Open API 제한사항

한 번의 요청으로 조회할 수 있는 기간은 최대 31일입니다.

MXQL Open API 호출하기

MXQL text API

다음 이미지는 MXQL 실행 결과 예시입니다.

MXQL 실행 결과 예시

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Request Body schema: application/json
required

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
mql required	string 직접 작성한 MXQL 쿼리
limit required	integer 최대 데이터 조회 수
pageKey required	string 문자열 `mxql` 고정값
	object 다음 문서 참조 예시, `{ "default": "ORDER {key : [oid], sort : [desc] }"}`
	object 다음 문서 참조 예시 : `{ "$oidFirst": "520111224", "$oidSecond": "1031483086" }`

Responses

Response Schema: application/json

time	integer <int64> 데이터 기록 시간
pcode	integer 프로젝트 코드
pname	string 프로젝트 이름
okind	integer 종류별 에이전트 그룹 고유 식별자(ID)
onode	integer 서버별 에이전트 그룹 고유 식별자(ID)
oname	string 에이전트 이름
okindName	string 종류별 에이전트 그룹 이름
onodeName	string 서버별 에이전트 그룹 이름
host_ip	string 호스트 IP 주소
container	string 컨테이너 식별자
pid	integer 프로세스 ID
type	string 플랫폼 종류
containerKey	integer 컨테이너 키
tx_count	integer 트랜잭션 수
tx_error	integer 에러가 발생한 트랜잭션 수
tx_time	number <double> 트랜잭션 처리 시간
apdex_satisfied	integer Apdex - 만족 S
apdex_tolerated	integer Apdex - 허용 T
apdex_total	integer Apdex
tx_dbc_time	number <double> 데이터베이스 커넥션에 소요된 시간
tx_sql_time	number <double> SQL 처리 시간
tx_httpc_time	number <double> HTTP 클라이언트 처리 시간
sql_count	integer SQL 쿼리 수
sql_error	integer 에러가 발생한 SQL 쿼리 수
sql_time	number <double> SQL 처리 시간
sql_fetch_count	integer SQL 패치 횟수
sql_fetch_time	number <double> SQL 패치 시간
httpc_count	integer HTTP 클라이언트 요청 수
httpc_error	integer 에러가 발생한 HTTP 클라이언트 요청 수
httpc_time	number <double> HTTP 클라이언트 처리 시간
active_tx_count	integer 액티브 트랜잭션 수
active_tx_0	integer 3초 미만 액티브 트랜잭션
active_tx_3	integer 3초 이상 액티브 트랜잭션
active_tx_8	integer 8초 이상 액티브 트랜잭션
tps	number <double> 초당 트랜잭션 처리 수
resp_time	integer 응답시간
arrival_rate	number <double> 초당 도착률
pack_dropped	integer 드롭된 패킷 수
metering	integer 미터링
_clock_delta_	integer 시계 차이
oid	integer 에이전트 고유 식별자(ID)

Request samples

Payload
curl

Content type

application/json

{"stime": 1639016640000,
"etime": 1639016940000,
"mql": "CATEGORY app_counter\nOID [ $oidFirst, $oidSecond ]\nTAGLOAD\nSELECT\nINJECT sortByOidDesc",
"limit": 2,
"pageKey": "mxql",
"inject": {"sortByOidDesc": "ORDER {key : [oid],  sort :[desc]}"
},
"param": {"$oidFirst": "1499132250",
"$oidSecond": "1670734023"
}
}

Response samples

200

Content type

application/json

Example

조회된 데이터가 있는 경우

[{"time": 1639016640000,
"pcode": 101,
"pname": "Virtual",
"okind": -1085056726,
"onode": 334634079,
"oname": "22136-8075",
"okindName": "ote-virtual-1",
"onodeName": "node-1",
"host_ip": "192.168.1.57",
"container": "ote-8075.service",
"pid": 22206,
"type": "java",
"containerKey": 1876424218,
"tx_count": 58,
"tx_error": 0,
"tx_time": 1643.9138,
"apdex_satisfied": 41,
"apdex_tolerated": 16,
"apdex_total": 58,
"tx_dbc_time": 13.655172,
"tx_sql_time": 222.15517,
"tx_httpc_time": 717.4138,
"sql_count": 129,
"sql_error": 0,
"sql_time": 101.387596,
"sql_fetch_count": 37621,
"sql_fetch_time": 0.00045187527,
"httpc_count": 41,
"httpc_error": 0,
"httpc_time": 1073.4878,
"active_tx_count": 20,
"active_tx_0": 19,
"active_tx_3": 1,
"active_tx_8": 0,
"tps": 13.833333,
"resp_time": 1628,
"arrival_rate": 12.6,
"pack_dropped": 110,
"metering": 4,
"_clock_delta_": 180,
"oid": 1670734023
}
]

MXQL path API

header Parameters

x-whatap-token required	string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}}
x-whatap-pcode required	string 프로젝트 코드 {{projectCode}

Request Body schema: application/json
required

stime required	integer <int64> 조회 시작 시간(UNIX epoch time, millisecond)
etime required	integer <int64> 조회 종료 시간(UNIX epoch time, millisecond)
mql required	string 직접 작성한 MXQL 쿼리
limit required	integer 최대 데이터 조회 수
pageKey required	string 문자열 `mxql` 고정값
	object 다음 문서 참조 예시, `{ "default": "ORDER {key : [oid], sort : [desc] }"}`
	object 다음 문서 참조 예시 : `{ "$oidFirst": "520111224", "$oidSecond": "1031483086" }`

Responses

Response Schema: application/json

pcode	integer 프로젝트 코드
pname	string 프로젝트 이름
oid	integer 에이전트 고유 식별자(ID)
oname	string 에이전트 이름
otype	string 에이전트 타입
okind	integer 종류별 에이전트 그룹 고유 식별자(ID)
okindName	string 종류별 에이전트 그룹 이름
onode	integer 서버별 에이전트 그룹 고유 식별자(ID)
onodeName	string 서버별 에이전트 그룹 이름
type	string 상품 종류
subtype	string 플랫폼 종류
version	string 버전 정보
os_name	string 운영체제 이름
ip	string IP 주소
container_id	integer 컨테이너 ID
metering	integer 미터링
status	string 상태 정보
normal	integer 정상 처리된 트랜잭션 수
slow	integer 느린 트랜잭션 수
verySlow	integer 매우 느린 트랜잭션 수
total	integer 총 트랜잭션 수
_pk_	string inject

Request samples

Payload

Content type

application/json

{"stime": 1639016640000,
"etime": 1639016940000,
"mql": "/app/act_tx/agent_with_tx",
"limit": 2,
"pageKey": "mxql",
"inject": {"default": "CREATE {key : _pk_, value : okindName}"
},
"param": { }
}

Response samples

200

Content type

application/json

Example

조회된 데이터가 있는 경우

[{"pcode": 101,
"pname": "Virtual",
"oid": -1348176005,
"oname": "22137-8071",
"otype": "ap",
"okind": -1085056726,
"okindName": "ote-virtual-1",
"onode": 334634079,
"onodeName": "node-1",
"type": "ap",
"subtype": "java",
"version": "2.1.0 20211207u",
"os_name": "Linux",
"ip": "192.168.1.57",
"container_id": 842770198,
"metering": 4,
"status": "ok",
"normal": 12,
"slow": 1,
"verySlow": 0,
"total": 13,
"_pk_": "okindName"
},
{"pcode": 101,
"pname": "Virtual",
"oid": -883058050,
"oname": "22141-8070",
"otype": "ap",
"okind": -933992004,
"okindName": "ote-virtual-0",
"onode": 1693789385,
"onodeName": "node-0",
"type": "ap",
"subtype": "java",
"version": "2.1.0 20211207u",
"os_name": "Linux",
"ip": "192.168.1.57",
"container_id": 624997205,
"metering": 4,
"status": "ok",
"normal": 19,
"slow": 1,
"verySlow": 0,
"total": 20,
"_pk_": "okindName"
}
]

WhaTap Open API

Open API

Open API Token 확인

계정 토큰 확인하기

프로젝트 토큰 확인하기

프로젝트

프로젝트 목록 조회

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

프로젝트 정보 조회

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

프로젝트 멤버 목록 조회

path Parameters

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

그룹

그룹 목록 조회

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

그룹 멤버 목록 조회

path Parameters

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

그룹에 포함된 프로젝트 조회

path Parameters

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

에이전트

에이전트 상태 및 호스트 IP 조회

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

oid 목록 호출

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

APM Spot 정보 조회

모든 정보 조회

header Parameters

Responses

Response Schema: application/json

Request samples

Response samples

활성화 상태의 에이전트 수 조회

header Parameters

Responses

Response Schema: text/plain

Request samples

Response samples

비활성화 상태의 에이전트 수 조회

header Parameters

Responses

Response Schema: text/plain

Request samples

Response samples

호스트(HOST) 수

Request Body schema: application/json
required