Skip to main content
API docs by Redocly

WhaTap Open API

Open API

To extract the monitoring data being collected and use it separately, the function to extract data is provided through Open API. You can obtain the collected data by passing the account API token, project API token, and project code as parameters.

For older versions of Open API documentation, see the following.

Checking the open API token

Tokens are divided into account API tokens and project API tokens. The account API token is used to acquire the project list, and the project API token is used to acquire project monitoring data.

You can check the project code through the data displayed like "[{project code}] Cloud Application Monitoring" in the window or tab title at the top of the browser screen when entering the project. To change the API token, select Reissue or Reissue Token on each screen.

Type Key Set value Remarks
Header x-whatap-token API token Account API Token
Header x-whatap-token API token Project API Token
Header x-whatap-pcode Project code Check in the window or browser tab title

Checking the account token

  1. Select the profile icon on the upper right of the screen.

  2. If a pop-up menu appears, select Manage Accounts.

  3. Scroll down the screen, go to the Api token section.

Checking the project token.

  1. Select a project in the Home screen.

  2. After entering the project, select Management > Project Management on the left.

  3. Check the Api token.

Project

Viewing the project list

This API provides the list of projects.

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json
Array of objects
accountEmail
string

Email address of the user account

total
integer

Project count

Request samples 

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

Response samples

Content type
application/json
{
  • "data": {
    • "0": {
      }
    },
  • "accountEmail": "xxx@whatap.io",
  • "total": 6
}

Viewing the project information

This API provides the projects for applications and servers.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
One of
platform
string

Application Product Platform

createTime
string

Project creation date

gatewayName
string

Data Server Region

projectCode
number

pcode

status
string
Enum: "pending" "trial" "subscribe" "close_pending" "limited" "closed" "trial_limited"

Project status

lastUpdatedTime
string

Project modification date

name
string

Project name

productType
string

Application Product Type

Request samples 

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

Content type
application/json
Example
{
  • "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"
}

Viewing the project member list

This API provides the list of members in the project.

path Parameters
projectCode
required
integer

pcode

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json
Array of objects
total
integer

Project member count

Request samples 

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

Response samples

Content type
application/json
{
  • "data": {
    • "0": {
      }
    },
  • "totla": 8
}

Group

Viewing the group list

This API provides a list of groups to which the user belongs.

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json
Array of objects
total
integer

Group Count

Request samples 

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

Response samples

Content type
application/json
{
  • "data": {
    • "0": {
      }
    },
  • "total": 3
}

Viewing the group member list

This API provides a list of members in the group to which the user belongs.

path Parameters
groupKey
required
integer

Group's unique identifier (ID)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json
Array of objects
total
integer

Group Member Count

Request samples 

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

Response samples

Content type
application/json
{
  • "data": {
    • "0": {
      }
    },
  • "totla": 8
}

Viewing the project in the group

This API views meta information of the projects in the group.

path Parameters
groupKey
required
integer

Group's unique identifier (ID)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

Responses

Response Schema: application/json
Array of objects
Array
projectCode
integer

pcode

name
string

Project name

status
string
Enum: "pending" "trial" "subscribe" "close_pending" "limited" "closed" "trial_limited"

Project status

productType
string

Product Type of Project

platform
string

Product Platform of Project

gatewayName
string

Data Server Region

Request samples 

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

Response samples

Content type
application/json
{
  • "data": {
    • "0": {
      }
    }
}

Agent

Viewing the agent status and host IP

This API provides the status and IP addresses of the agents in the project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
Array
host_ip
string <ipv4>

IP Address

oname
string

Agent name

active
boolean

Agent Activation Status

Request samples 

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

Content type
application/json
{
  • "data": {
    • "0": {
      }
    }
}

Calling the oid list

This API allows you to view active agents during the desired period. The query time (stime, etime) is limited to one day and its unit is ms (millisecond).

Among the sample codes in the example, change the parameter values such as stime and etime according to the user environment. The parameter values can be requested in various formats.

  • 1693475430087 (unix timestamp)

  • yyyyMMddHHmmss

  • yyyyMMddHHmm

  • MMddHHmmss

  • MMddHHmm

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Request Body schema: application/json
required
stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

Responses

Response Schema: application/json
stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

timestamp
integer <int64>

Data creation time (UNIX epoch time, millisecond)

Array of objects

Request samples

Content type
application/json
{
  • "stime": 1690850183000,
  • "etime": 1693321200000
}

Response samples

Content type
application/json
{
  • "stime": 1690850183000,
  • "etime": 1693321200000,
  • "timestamp": 1693388196965,
  • "data": {
    • "0": {
      }
    }
}

Event History

Querying the event history

You can querying the event records that occurred in the project.

query Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

progress
boolean
  • true: Query only events in progress
  • false: Query all events, including those in progress
oid
integer <int32>
  • Agent's unique identifier (ID). You can enter multiple values ​​using commas (,) as the delimiter.
  • URL encoded required: 17079562,352247167 → -17079562%2C352247167
okinds
integer <int32>
  • Agent group IDs for each type. You can enter multiple values ​​using commas (,) as the delimiter.
  • URL encoded required: 17079562,352247167 → -17079562%2C352247167
onodes
integer <int32>
  • Agent group IDs for each server, You can enter multiple values ​​using commas (,) as the delimiter.
  • URL encoded required: 17079562,352247167 → -17079562%2C352247167
header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
metricName
string

Metrics name

pcode
integer

Project code

onodeName
string

Agent Group Name per Server

displayTag
string

Value for displaying event status tags

metricValue
float

Metrics value

oid
integer

Agent's unique identifier (ID)

title
string

Event title

uuid
integer

Event unique identifier

okind
integer

Agent Group IDs for each Type

ackCount
integer

Acknowledge count

eventTime
integer <int64>

Time when the event occurred

disabled
boolean

Whether the event has ended:

  • If the event is resolved due to a value below the threshold
  • If the user intentionally disables the event rule.
  • If the event is blocked due to mass notifications, etc.
  • If the event has additional acknowledge
id
integer

Event unique identifier (ID)

acknowledges
Array of arrays

Acknowledge

stateful
boolean

Whether to enable the resolved event notification feature

product
string

Server type

level
string

Warning level

updateTime
integer <int64>

Event update time

message
string

Event message

metricThreshold
string

Threshold

oname
string

Agent name

escalation
boolean

Whether to repeat notifications

tagCount
boolean

TagCount Category Event

systemEvent
boolean

System event

offTime
integer

Resolved time

category
string

TagCount Category

okindName
sting

Agent Group Name per Type

onode
integer

Agent Group IDs for each Server

snapshot
string

Snapshot at the time the event occurred (only for basic events on the server)

status
string

Event status

Request samples 

curl --location \
-w "\n" \
-H 'x-whatap-token: {{PROJECT_API_TOKEN}}' \
-H 'x-whatap-pcode: {{projectCode}}' \
"https://api.whatap.io/open/api/json/event/history?stime=1733065200000&etime=1733103557000&progress=true&oids=-17079562%2C352247167"

Response samples

Content type
application/json
{
  • "0": {
    • "metricName": "mem",
    • "pcode": "7",
    • "onodeName": "",
    • "displayTag": "inprogress",
    • "metricValue": "99.73802",
    • "oid": -17079562,
    • "title": "Server Memory",
    • "uuid": "c5cf01fe9daf43ce99a9028e0a804d35",
    • "okind": "0,",
    • "ackCount": "0,",
    • "eventTime": "1733288350068,",
    • "disabled": "false,",
    • "id": "44,",
    • "acknowledges": { },
    • "stateful": true,
    • "process": 0,
    • "product": "ap",
    • "level": "Critical",
    • "triggerId": 0,
    • "updateTime": 1733288350128,
    • "message": "Server Memory = 99.738",
    • "metricThreshold": "90",
    • "oname": "front",
    • "escalation": true,
    • "tagCount": true,
    • "systemEvent": false,
    • "offTime": 0,
    • "category": "app_host_resource",
    • "okindName": "",
    • "onode": 0,
    • "snapshot": null,
    • "status": "ON"
    },
  • "1": {
    • "metricName": "cpu",
    • "pcode": 7,
    • "onodeName": "",
    • "displayTag": "inprogress",
    • "metricValue": "19.947985",
    • "oid": -17079562,
    • "title": "Server CPU",
    • "uuid": "5d7a40d11a1144a8b7bad7e2c71cda2e",
    • "okind": 0,
    • "ackCount": 0,
    • "eventTime": 1733288325022,
    • "disabled": false,
    • "id": 42,
    • "acknowledges": { },
    • "stateful": true,
    • "process": 0,
    • "product": "ap",
    • "level": "Warning",
    • "triggerId": 0,
    • "updateTime": 1733288325055,
    • "message": "Server CPU = 19.948",
    • "metricThreshold": "0",
    • "oname": "front",
    • "escalation": false,
    • "tagCount": true,
    • "systemEvent": false,
    • "offTime": 0,
    • "category": "app_host_resource",
    • "okindName": "",
    • "onode": 0,
    • "snapshot": null,
    • "status": "ON"
    }
}

APM spot information API

It provides a list of APIs that allow you to view the agent information and related metrics for application monitoring projects.

Viewing all information

This API allows you to view all information of the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

act_agent
string

Active agent count

inact_agent
string

Inactive agent count

host
string

Host count

cpucore
string

Total number of CPU cores on the host

txcount
string

Transaction Count

tps
string

TPS

user
string

Active users (5 minutes)

actx
string

Active Transaction

rtime
string

Average Response Time (ms)

cpu
string

Average CPU utilization(%)

threadpool_active
string

Active thread count of the thread pool

threadpool_queue
string

Queuing thread count of the thread pool

dbconn_total
string

Total DB connection count

dbconn_act
string

Active DB connection count

dbconn_idle
string

Idle DB connection count

act_method
string

Active Method Count

act_sql
string

Active SQL Count

act_httpc
string

Active HTTP Call Count

act_dbc
string

Number of Active Database Connections

act_socket
string

Number of Active Socket Connections

apdex
string

Apdex (Application Performance Index, user satisfaction for applications)

Request samples 

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

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"
}

Viewing the active agent count

This API allows you to view the number of active agents in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

Active agent count

Request samples 

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

Content type
text/plain
5

Viewing the inactive agent count

This API allows you to view the number of inactive agents in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

Inactive agent count

Request samples 

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

Content type
text/plain
2

Host count

This API allows you to view the number of hosts connected to the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

Host Count

Request samples 

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

Content type
text/plain
5

Sum of CPU cores of the host

This API allows you to view the sum of CPU cores of the host connected to the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

CPU core count

Request samples 

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

Content type
text/plain
16

Transaction Count

This API allows you to view the number of transactions in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

Transaction Count

Request samples 

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

Content type
text/plain
469

TPS

This API allows you to view the number of transactions per second (TPS) in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
number <float>

Number of Processed Transactions per second

Request samples 

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

Content type
text/plain
92.03

Active users (5 minutes)

This API allows you to view concurrent users in the application monitoring project, which measures users who issued transactions within the last 5 minutes.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

Real-time user count for 5 minutes

Request samples 

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

Content type
text/plain
1007

Active Transaction

This API allows you to view the number of active transactions in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

Active transaction count

Request samples 

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

Content type
text/plain
171

Average Res. Time

This API allows you to view the average response time in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
integer

Average Res. Time

Request samples 

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

Content type
text/plain
1644

Average CPU utilization

This API allows you to view the average CPU utilization in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
number <float>

Average CPU utilization

Request samples 

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

Content type
text/plain
9.26

Apdex

This API allows you to view the Apdex (Application Performance Index, application user satisfaction) in the application monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
number <float>

Apdex

Request samples 

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

Content type
text/plain
0.9871

APM viewing the statistical data

It provides a list of APIs that allow you to view the statistical data for application monitoring projects.

Exception

This API allows you to view the exception details during the time set in the application monitoring project.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
total
integer

Total Number of Exception Records

Request samples 

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

Content type
application/json
{
  • "records": {
    • "0": {
      }
    },
  • "total": 2063
}

HTTP outbound call

This API allows you to view the HTTP outbound call records during the time set in the application monitoring project.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
total
integer

Total Number of HTTP Connection Records

Request samples 

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

Content type
application/json
{
  • "records": {
    • "0": {
      }
    },
  • "total": 4923
}

HTTP Outbound Call Filtering

This API allows you to filter HTTP outbound call records based on the host address and port number during the time set in the application monitoring project.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

host
required
string

Host Address for Filtering

port
required
string

Host Port Number for Filtering

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
total
integer

Total Number of HTTP Connection Records

Request samples 

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

Content type
application/json
{
  • "records": {
    • "0": {
      },
    • "1": {
      }
    },
  • "total": 1080
}

SQL

This API allows you to view the SQL statements during the time set in the application monitoring project.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
total
integer

Total Number of SQL Query Records

Request samples 

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

Content type
application/json
{
  • "records": {
    • "0": {
      }
    },
  • "total": 130
}

Client IP

This API allows you to view the remote client IPs during the time set in the application monitoring project. WhaTap basically stores the client-related information.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
total
integer

Total Number of Remote Client IP Records

Request samples 

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

Content type
application/json
{
  • "records": {
    • "0": {
      }
    },
  • "total": 1000
}

Transactions

This API allows you to view the transaction records during the time set in the application monitoring project.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
total
integer

Total Transaction Record Count

Request samples 

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

Content type
application/json
{
  • "records": {
    • "0": {
      }
    },
  • "total": 1080
}

Heap use - statistics average

This API allows you to view the average statistics for heap usage during the time set in the application monitoring project. The query time is limited to one hour and is measured in milliseconds (ms).

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

timeMerge
string

Data Collection Method (avg or max)

unit
string

Heap Usage Unit (e.g. byte)

Array of objects

Request samples 

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

Content type
application/json
{
  • "pcode": 5490,
  • "stime": 1677747600000,
  • "etime": 1677749594269,
  • "timeMerge": "avg",
  • "unit": "byte",
  • "data": {
    • "0": {
      },
    • "1": {
      }
    }
}

Heap use - statistics maximum

This API allows you to view the maximum statistics for heap usage during the time set in the application monitoring project. The query time is limited to one hour and is measured in milliseconds (ms).

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

timeMerge
string

Data Collection Method (avg or max)

unit
string

Heap Usage Unit (e.g. byte)

Array of objects

Request samples 

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

Content type
application/json
{
  • "pcode": 5490,
  • "stime": 1677747600000,
  • "etime": 1677749594269,
  • "timeMerge": "max",
  • "unit": "byte",
  • "data": {
    • "0": {
      },
    • "1": {
      }
    }
}

Viewing the agent data

This API allows you to view the data for all agents during the time set in the application monitoring project.

path Parameters
metric_type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller"

Metric that can be viewed

stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller"

Metric that can be viewed

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

interval
integer

Data Point Interval (sec)

timeMerge
string

Data Collection Method (sum)

Array of objects

Request samples 

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

Content type
application/json
{
  • "pcode": 1234570141,
  • "type": "metric_type",
  • "stime": 1536050100000,
  • "etime": 1536050700000,
  • "interval": 300,
  • "timeMerge": "sum",
  • "objects": {
    • "0": {
      },
    • "1": {
      }
    }
}

Query for average agent data

This API allows you to view the average data for all agents during the time set in the application monitoring project.

path Parameters
metric_type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex"

Metric that can be viewed

stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex"

Metric that can be viewed

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

interval
integer

Data Point Interval (sec)

timeMerge
string

Data Collection Method (sum)

objectMerge
string

Data Merge Method (avg)

Array of items

Request samples 

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

Content type
application/json
{
  • "pcode": 1234570141,
  • "type": "metric_type",
  • "stime": 1536050100000,
  • "etime": 1536050700000,
  • "interval": 300,
  • "timeMerge": "sum",
  • "objectMerge": "avg",
  • "series": {
    • "0": {
      },
    • "1": {
      },
    • "2": {
      }
    }
}

Viewing the specified agent data

This API allows you to view the thread counts of the specified agents (oids) during the time set in the application monitoring project. Multiple agents (oids) can be specified using comma (,) as the delimiter.

path Parameters
metric_type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller"

Metric that can be viewed

stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

oids
required
integer <int32>

Multiple agent identifiers (ID) can be entered using comma (,) as the delimiter.

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex" "tx_caller"

Metric that can be viewed

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

interval
integer

Data Point Interval (sec)

timeMerge
string

Data Collection Method (sum)

Array of objects

Request samples 

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

Content type
application/json
{
  • "pcode": 1234570141,
  • "type": "metric_type",
  • "stime": 1536050100000,
  • "etime": 1536050700000,
  • "interval": 300,
  • "timeMerge": "sum",
  • "objects": {
    • "0": {
      },
    • "1": {
      }
    }
}

Viewing the specified average agent data

This API allows you to view the average data of the specified agents (oids) during the time set in the application monitoring project. Multiple agents (oids) can be specified using comma (,) as the delimiter.

path Parameters
metric_type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex"

Metric that can be viewed

stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

type
string
Enum: "thread_count" "thread_daemon" "thread_peak_count" "threadpool_active" "threadpool_queue" "apdex"

Metric that can be viewed

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

interval
integer

Data Point Interval (sec)

timeMerge
string

Data Collection Method (sum)

objectMerge
string

Data Merge Method (avg)

Array of items

Request samples 

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

Content type
application/json
{
  • "pcode": 1234570141,
  • "type": "metric_type",
  • "stime": 1536050100000,
  • "etime": 1536050700000,
  • "interval": 300,
  • "timeMerge": "sum",
  • "objectMerge": "avg",
  • "series": {
    • "0": {
      },
    • "1": {
      },
    • "2": {
      }
    }
}

Viewing active users per 5 minutes

This API allows you to view the concurrent users at an interval of 5 minutes during the time set in the application monitoring project. The measure of concurrent users is for users who issued transactions within the last 5 minutes.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of items
pcode
integer

pcode

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

total
integer

Total Visitor Count

Request samples 

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

Content type
application/json
{
  • "data": {
    • "0": {
      },
    • "1": {
      }
    },
  • "pcode": 3000000079,
  • "stime": 1554444000000,
  • "etime": 1554444300000,
  • "total": 59
}

Viewing active users per 1 hour

This API allows you to view the concurrent users at an interval of 1 hour during the time set in the application monitoring project.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of items
pcode
integer

pcode

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

total
integer

Total number of data arrays

Request samples 

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

Content type
application/json
{
  • "data": {
    • "0": {
      },
    • "1": {
      }
    },
  • "pcode": 3000000079,
  • "stime": 1554444000000,
  • "etime": 1554454800000,
  • "total": 59
}

Viewing active users per 1 day

This API allows you to view the concurrent users at an interval of 1 day during the time set in the application monitoring project.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of items
pcode
integer

pcode

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

total
integer

Total Visitor Count

Request samples 

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

Content type
application/json
{
  • "data": {
    • "0": {
      },
    • "1": {
      },
    • "2": {
      }
    },
  • "pcode": 3000000079,
  • "stime": 1554163200000,
  • "etime": 1554422400000,
  • "total": 3
}

Viewing active users per 1 month

This API allows you to view the concurrent users at an interval of 1 month during the time set in the application monitoring project. As the unique user statistics aggregated for 1 month, etime cannot exceed 365 days based on stime.

path Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects

User Statistical Data per Month

pcode
integer

pcode

stime
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
integer <int64>

Query end time (UNIX epoch time, millisecond)

sdate
string

String expression on the search start time

edate
string

String expression on the search end time

total
integer

Total Visitor Count

Request samples 

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

Content type
application/json
{
  • "data": {
    • "0": {
      },
    • "1": {
      }
    },
  • "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
}

Call Statistics Filtering

You can filter cross-project transaction call statistics or transaction domain call statistics for view.

  • filterkey: Query condition keys (caller_pcode, caller_spec (version), caller_url, spec (version), url)

  • filterval: Query condition (base64 encoding if filterkey is caller_url or url)

path Parameters
metric_type
string
Enum: "tx_caller" "tx_domain"

Metric that can be viewed

stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

filterkey
required
string
Enum: "caller_pcode" "caller_spec" "caller_url" "spec" "url"

Query condition key

filterval
required
string

Query condition (if filterkey is caller_url or url, base64 encoding is applied)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Request samples 

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}"

Filtering the designated agent's calls

You can filter cross-project transaction call statistics or transaction domain call statistics based on the specified agent for view.

  • filterkey: Query condition keys (caller_pcode, caller_spec (version), caller_url, spec (version), url)

  • filterval: Query condition (base64 encoding if filterkey is caller_url or url)

path Parameters
metric_type
string
Enum: "tx_caller" "tx_domain"

Metric that can be viewed

stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

oids
required
integer <int32>

Multiple agent identifiers (ID) can be entered using comma (,) as the delimiter.

filterkey
required
string
Enum: "caller_pcode" "caller_spec" "caller_url" "spec" "url"

Query condition key

filterval
required
string

Query condition (if filterkey is caller_url or url, base64 encoding is applied)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Request samples 

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

This API allows you to view the TPS (Transaction Per Second) data during the time set in the application monitoring project.

query Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

timeMerge
required
string
Value: "avg"

Data collection method

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
number <float>

TPS Count

Request samples 

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

Content type
text/plain
66.0

Average response time

This API allows you to view the average response time during the time set in the application monitoring project.

query Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

timeMerge
required
string
Value: "avg"

Data collection method

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
number

Average response time

Request samples 

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

Content type
text/plain
1640

Average CPU utilization

This API allows you to view the average CPU utilization during the time set in the application monitoring project.

query Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

timeMerge
required
string
Value: "avg"

Data collection method

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: text/plain
number

Average CPU utilization

Request samples 

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

Content type
text/plain
11.50

DB connection counts for each data source

This API allows you to view the DB connection counts for each data source during the time set in the application monitoring project.

query Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

timeMerge
required
string
Value: "avg"

Data collection method

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

time
integer <int64>

Lookup time

Array of objects (ConnectionDetail)

Request samples 

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

Content type
application/json
{
  • "pcode": 35,
  • "time": 1554163200000,
  • "dbc_total": {
    • "0": {
      }
    }
}

DB connection counts for each data source - short-term search

This API allows you to view the DB connection counts for each data source based on the end time set in the application monitoring project.

query Parameters
etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

header Parameters
x-whatap-token
required
string

Account API Token {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

time
integer <int64>

Lookup time

Array of objects (ConnectionDetail)

Request samples 

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

Content type
application/json
{
  • "pcode": 17,
  • "time": 1667467012037,
  • "dbc_total": {
    • "0": {
      },
    • "1": {
      }
    }
}

IP-based transaction search

For one hour from the user-specified start time (stime), transactions requested by a specific IP are sorted in descending order of the call count and up to 100 URLs are delivered by this API.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Request Body schema: application/json
required
type
string
path
string
pcode
string

pcode

object

Responses

Response Schema: application/json
elapsed
number

Elapsed time from the start time (stime)

count
number

HTTP Call Count

url
string

Name of the transaction requested by the client

Request samples

Content type
application/json
{
  • "type": "profiles",
  • "path": "/filter/search",
  • "pcode": "12345",
  • "params": {
    • "stime": 1690850183000,
    • "filter": {
      }
    }
}

Response samples

Content type
application/json
{
  • "elapsed": 0,
  • "count": 0,
  • "url": "string"
}

Server spot information API

It provides a list of APIs that allow you to view the agent information and related metrics for server monitoring projects.

Viewing the active agent count

This API allows you to view the number of active agents in the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pname
string

Project name

values
string

Count

Request samples 

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

Content type
application/json
{
  • "pname": "LOCAL_INFRA",
  • "values": "57.0"
}

Viewing the inactive agent count

This API allows you to view the number of inactive agents in the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pname
string

Project name

values
string

Count

Request samples 

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

Content type
application/json
{
  • "pname": "LOCAL_INFRA",
  • "values": "4.0"
}

Host count

This API allows you to view the number of hosts connected to the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pname
string

Project name

values
string

Count

Request samples 

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

Content type
application/json
{
  • "pname": "LOCAL_INFRA",
  • "values": "57.0"
}

Sum of CPU cores of the host

This API allows you to view the sum of CPU cores of the host connected to the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pname
string

Project name

values
string

Count

Request samples 

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

Content type
application/json
{
  • "pname": "LOCAL_INFRA",
  • "values": "108.0"
}

CPU Utilization

This API allows you to view the CPU utilization of the host connected to the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

pname
string

Project name

timezone
integer

Time Zone

regionName
string

Data Server Region

object

CPU Utilization per Server (%)

language
string

Alert Language

Request samples 

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

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"
}

Sum of disk IOPS

This API allows you to view the sum of disk IOPS of the host connected to the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

pname
string

Project name

timezone
integer

Time Zone

regionName
string

Data Server Region

object
language
string

Alert Language

Request samples 

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

Content type
application/json
{
  • "pcode": 29763,
  • "pname": "Server Monitoring Demo",
  • "timezone": 9,
  • "regionName": "LOCAL",
  • "values": {
    • "mysql-official-demo-03": {
      },
    • "php-official-demo": {
      },
    • "python-demo-attacker": {
      },
    • "virtual-java-agent": {
      }
    },
  • "language": "en"
}

Sum of network traffic (IN/OUT)

This API allows you to view the sum of network traffic (IN/OUT) of the host connected to the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

pname
string

Project name

timezone
integer

Time Zone

regionName
string

Data Server Region

object
language
string

Alert Language

Request samples 

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

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"
}

Process status

This API allows you to view the process status of the host connected to the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pname
string

Project name

object
language
string

Alert Language

Request samples 

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

Content type
application/json
{
  • "pname": "LOCAL_INFRA",
  • "values": {
    • "s-p-gtw-03": {
      },
    • "t-a-yrd-01": {
      }
    }
}

Server List

This API allows you to view a list of servers of the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
pcode
integer

pcode

pname
string

Project name

timezone
integer

Time Zone

regionName
string

Data Server Region

Array of objects
language
string

Alert Language

Request samples 

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

Content type
application/json
{
  • "pcode": 29763,
  • "pname": "Server Monitoring Demo",
  • "timezone": 9,
  • "regionName": "LOCAL",
  • "values": {
    • "0": {
      },
    • "1": {
      },
    • "2": {
      }
    },
  • "language": "en"
}

Server monitoring details

This API allows you to view the details for each server in the server monitoring project.

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Request samples 

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

Content type
application/json
{
  • "pname": "LOCAL_INFRA",
  • "values": {
    • "servers": {
      },
    • "max": {
      },
    • "count": {
      },
    • "tags": { }
    }
}

Server viewing the statistical data

Server statistics details

This API allows you to view the statistical data of the server monitoring project. The query time is limited to one hour and is measured in milliseconds (ms).

  • filter: The default value is m5. Enter m5 to view 5-minute statistics, s5 for 5-second statistics, and h1 for 1-hour statistics.

  • oid: Add to view the data for the specified agent.

Parameters other than oid cannot be applied.

query Parameters
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

filter
required
string
Enum: "m5" "s5" "h1"
oid
required
integer <int32>

Agent's unique identifier (ID)

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects
Array
oid
integer

Agent's unique identifier (ID)

Array of objects

Request samples 

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

Content type
application/json
{
  • "servers": {
    • "0": {
      }
    }
}

Database viewing the parameter

You can view the parameters in the database.

Viewing the parameter changes

You can view the changes to parameters in the database.

query Parameters
oid
required
integer <int32>

Agent's unique identifier (ID)

baeTime
required
string <yyyyMMdd>

Reference time

comparisonTime
required
string <yyyyMMdd>

Comparison time

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: applciation/json
Array of objects (UnmatchedKey)

Keys and their values ​that do not match at the reference time and comparison time

Array of objects (MatchedParameter)

List of parameters within the reference time

Array of objects (MatchedParameter)

List of parameters within the comparison time

Request samples 

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

Content type
applciation/json
{
  • "unmatchedKeys": {
    • "0": {
      },
    • "1": {
      }
    },
  • "baseTime": {
    • "0": {
      },
    • "1": {
      }
    },
  • "comparisonTime": {
    • "0": {
      },
    • "1": {
      }
    }
}

Database viewing SQL

You can view the SQLs in the database.

SQL statistics TopN

You can view the most used SQL statistical data during the set time.

query Parameters
oids
required
integer <int32>

Multiple agent identifiers (ID) can be entered using comma (,) as the delimiter.

period
required
string
Enum: "day" "weak"

Inquiry time

date
required
string <yyyyMMdd>

Reference time

topN
number <1 -1000>
Default: 10

Number of upper cases

order
string
Default: "sql_execute_cnt"
Enum: "sql_execute_cnt" "sql_elapse" "sql_elapse_max"

Sort by

category
string
Default: "ALL"
Enum: "ALL" "DB" "HOST" "USER"

If you select the category, USER, it responds with SQL statistical data on the user basis.

nameInCategory
string

Addition when category is selected as the parameter

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Responses

Response Schema: application/json
Array of objects (SqlRecord)
topN
integer

Requested TopN Value

total
integer

Total Number of Recorded SQL Records

retrievedStartTime
integer <int64>

Start Time for View

retrievedEndTime
integer <int64>

End Time for View

Request samples 

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

Content type
application/json
{
  • "records": {
    • "0": {
      },
    • "1": {
      }
    },
  • "topN": 10,
  • "total": 129,
  • "retrievedStartTime": 1692921600000,
  • "retrievedEndTime": 1693007999000
}

MXQL open API usage guide

You can use MXQL as follows.

  • How to write MXQL queries to retrieve data

  • As in the following, the method how to retrieve data by the predefined MXQL query list provided by the SaaS service

Therefore, the API path used in each case differs.

How to use MXQL API
In case of writing the MXQL queries MXQL text API
In case of using the predefined MXQL query list provided by the SaaS service (see the following) MXQL path API

The content included in the header upon open API call is as follows:

Type Key Set value Remarks
Header x-whatap-token API Token {{PROJECT API TOKEN}} Project API Token: Select Project > Management > Project Managemen > Api token
Header x-whatap-pcode Project code {{projectCode}} Project code: Select Project > Management > Project Managemen > pcode

Constraints of the MXQL open API

You can search up to 31 days in a single request.

Calling the MXQL open API

MXQL text API

The following image is an example of the MXQL execution result.

Example of MXQL execution result

header Parameters
x-whatap-token
required
string

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Request Body schema: application/json
required
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

mql
required
string

Written MXQL query

limit
required
integer

Maximum data query count

pageKey
required
string

The string MXQL's fixed value

object

See the following
e.g. { "default": "ORDER {key : [oid], sort : [desc] }"}

object

See the following
e.g. { "$oidFirst": "520111224", "$oidSecond": "1031483086" }

Responses

Response Schema: application/json
time
integer <int64>

Data Recorded Time

pcode
integer

pcode

pname
string

Project name

okind
integer

Agent Group IDs for each Type

onode
integer

Agent Group IDs for each Server

oname
string

Agent name

okindName
string

Agent Group Name per Type

onodeName
string

Agent Group Name per Server

host_ip
string

Host IP Address

container
string

Container ID

pid
integer

Process ID

type
string

Platform Type

containerKey
integer

Container Key

tx_count
integer

Transaction count

tx_error
integer

Number of Erroneous Transactions

tx_time
number <double>

Transaction Process Time

apdex_satisfied
integer

Apdex - Satisfactory S

apdex_tolerated
integer

Apdex - Allowed T

apdex_total
integer

Apdex

tx_dbc_time
number <double>

Time for Database Connection

tx_sql_time
number <double>

SQL Process Time

tx_httpc_time
number <double>

HTTP Client Process Time

sql_count
integer

SQL Query Count

sql_error
integer

Number of Erroneous SQL Queries

sql_time
number <double>

SQL Process Time

sql_fetch_count
integer

Number of SQL Fetches

sql_fetch_time
number <double>

SQL Fetch Time

httpc_count
integer

HTTP Client Request Count

httpc_error
integer

Number of Erroneous HTTP Client Requests

httpc_time
number <double>

HTTP Client Process Time

active_tx_count
integer

Active transaction count

active_tx_0
integer

Active Transactions in less than 3 seconds

active_tx_3
integer

Active Transactions in 3 seconds or more

active_tx_8
integer

Active Transactions in 8 seconds or more

tps
number <double>

Number of transactions per second

resp_time
integer

Response Time

arrival_rate
number <double>

Arrival Rate per second

pack_dropped
integer

Number of Dropped Packets

metering
integer

Metering

_clock_delta_
integer

Clock Difference

oid
integer

Agent's unique identifier (ID)

Request samples

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

Content type
application/json
Example
{
  • "0": {
    • "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

Project API Token {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

Project Code {{projectCode}

Request Body schema: application/json
required
stime
required
integer <int64>

Query start time (UNIX epoch time, millisecond)

etime
required
integer <int64>

Query end time (UNIX epoch time, millisecond)

mql
required
string

Written MXQL query

limit
required
integer

Maximum data query count

pageKey
required
string

The string MXQL's fixed value

object

See the following
e.g. { "default": "ORDER {key : [oid], sort : [desc] }"}

object

See the following
e.g. { "$oidFirst": "520111224", "$oidSecond": "1031483086" }

Responses

Response Schema: application/json
pcode
integer

pcode

pname
string

Project name

oid
integer

Agent's unique identifier (ID)

oname
string

Agent name

otype
string

Agent Type

okind
integer

Agent Group IDs for each Type

okindName
string

Agent Group Name per Type

onode
integer

Agent Group IDs for each Server

onodeName
string

Agent Group Name per Server

type
string

Product Type

subtype
string

Platform Type

version
string

Version

os_name
string

OS name

ip
string

IP Address

container_id
integer

Container ID

metering
integer

Metering

status
string

Status

normal
integer

Number of Normal Transactions

slow
integer

Number of Slow Transactions

verySlow
integer

Number of Very Slow Transactions

total
integer

Total Transaction Count

_pk_
string

inject

Request samples

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

Content type
application/json
Example
{
  • "0": {
    • "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"
    },
  • "1": {
    • "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"
    }
}