本文へスキップ
API docs by Redocly

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 プロジェクトコード 画面ウィンドウまたはブラウザのタブタイトルを確認してください

アカウントトークン確認

  1. 画面の右上にあるプロフィールアイコンを選択してください。

  2. ポップアップメニューが表示されたら、アカウント管理ボタンをクリックしてください。

  3. 画面を下にスクロールし、APIトークンセクションへ移動してください。

プロジェクトトークン確認

  1. ホーム画面からプロジェクトを選択してください。

  2. プロジェクトに入った後、左側の管理 > プロジェクト管理メニューを選択してください。

  3. 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 -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": [
    • {
      }
    ],
  • "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" "有償転換" "close_pending" "limited" "closed" "trial_limited"

プロジェクトステータス

lastUpdatedTime
string

プロジェクト編集日

name
string

プロジェクト名

productType
string

アプリケーション製品タイプ

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

プロジェクトメンバー一覧を参照

プロジェクトに所属するメンバーの一覧を照会する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 -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": [
    • {
      }
    ],
  • "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 -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": [
    • {
      }
    ],
  • "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 -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": [
    • {
      }
    ],
  • "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 -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": [
    • {
      }
    ]
}

エージェント

エージェント状態とホスト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 -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": [
    • {
      }
    ]
}

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

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

Response samples

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

イベント

イベント設定の取得

イベント設定（New）メニューの［JSON 一括ダウンロード］と同じデータを取得します。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json
productType
string

プロジェクトの製品タイプ

platform
string

プロジェクトの製品プラットフォーム

object

イベントタイプ別の設定リスト

Response samples

Content type
application/json
{
  • "productType": "string",
  • "platform": "string",
  • "events": {
    • "BASIC": [
      ],
    • "METRICS": [
      ],
    • "COMPOSITE_METRICS": [
      ],
    • "LOG_REALTIME": [
      ],
    • "COMPOSITE_LOG": [
      ],
    • "SERVER_LOG_FILE": [
      ],
    • "Transaction": [
      ],
    • "ANOMALY": [
      ]
    }
}

イベント記録照会

プロジェクトで発生したイベント履歴を照会できます。

query Parameters
stime
required
integer <int64>

照会開始時間(UNIX epoch time、millisecond)

etime
required
integer <int64>

照会終了時間(UNIX epoch time、millisecond)

progress
boolean
  • true: 進行中のイベントのみを表示
  • false: 進行中のイベントを含むイベント全体を照会する
oid
integer <int32>
  • エージェント固有識別子(ID)、コンマ(,)を区切り文字として複数入力可能
  • URLエンコードが必要：17079562,352247167 → -17079562%2C352247167
okinds
integer <int32>
  • タイプ別エージェントグループの固有識別子(ID)、コンマ(,)を区切り文字として複数入力可能
  • URLエンコードが必要：17079562,352247167 → -17079562%2C352247167
onodes
integer <int32>
  • サーバー別エージェントグループの固有識別子(ID)、コンマ(,)を区切り文字として複数入力可能
  • URLエンコードが必要：17079562,352247167 → -17079562%2C352247167
header Parameters
x-whatap-token
required
string

アカウントのAPIトークン {{ACCOUNT_API_TOKEN}}

x-whatap-pcode
required
string

プロジェクトコード {{projectCode}}

Responses

Response Schema: application/json
metricName
string

メトリクス名

pcode
integer

プロジェクトコード

onodeName
string

サーバー別エージェントグループ名

displayTag
string

イベントステータスタグを表示するための値

metricValue
float

メトリックス値

oid
integer

エージェント固有識別子(ID)

title
string

イベントタイトル

uuid
integer

イベント固有識別子

okind
integer

タイプ別エージェントグループの固有識別子(ID)

ackCount
integer

処理内容数

eventTime
integer <int64>

イベントが発生した時刻

disabled
boolean

イベント終了かどうか

  • しきい値未満の値発生でイベントが解消された場合
  • ユーザーが意図的にイベントルールを無効にした場合
  • 大量通知などの理由でブロックされたイベントの場合
  • 処理履歴が追加されたイベントの場合
id
integer

イベント固有識別子(ID)

acknowledges
Array of arrays

処理内容

stateful
boolean

解消されたイベント通知機能が有効かどうか

product
string

サーバータイプ

level
string

警告レベル

updateTime
integer <int64>

イベント更新時間

message
string

イベントメッセージ

metricThreshold
string

しきい値

oname
string

エージェント名

escalation
boolean

繰り返し通知するかどうか

tagCount
boolean

TagCountカテゴリイベントかどうか

systemEvent
boolean

システムイベントかどうか

offTime
integer

解消時刻

category
string

TagCount カテゴリ

okindName
sting

種類別エージェントのグループ名

onode
integer

サーバー別エージェントグループの固有識別子(ID)

snapshot
string

イベント発生時のスナップショット(サーバーの基本イベントのみ)

status
string

イベントステータス

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
[
  • {
    • "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"
    },
  • {
    • "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情報照会

アプリケーションモニタリングプロジェクトのエージェント情報および関連指標を照会できる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 -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"
}

アクティブ状態のエージェント数の照会

アプリケーションモニタリングプロジェクトで活性化状態のエージェント数を照会できる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 -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

非アクティブ状態のエージェント数の照会

アプリケーションモニタリングプロジェクトで非活性化状態のエージェント数を照会できる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 -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) 数

アプリケーションモニタリングプロジェクトに接続されたホスト(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 -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

ホスト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 -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

TX数

アプリケーションモニタリングプロジェクトでトランザクション数を照会できるAPIです。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

プロジェクトコード {{projectCode}}

Responses

Response Schema: text/plain
integer

TX数

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

アプリケーションモニタリングプロジェクトで1秒あたりに処理されたトランザクション数(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>

1秒間に処理されたトランザクション件数

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

アクティブユーザー（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 -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

アクティブトランザクション

アプリケーションモニタリングプロジェクトでアクティブトランザクション数を照会できる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 -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

平均応答時間

アプリケーションモニタリングプロジェクトで平均リスポンスタイムを照会できる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 -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

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

アプリケーションモニタリングプロジェクトで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 -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統計データの参照

アプリケーションモニタリングプロジェクトの統計データを照会できる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 -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": [
    • {
      }
    ],
  • "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 -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": [
    • {
      }
    ],
  • "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 -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": [
    • {
      },
    • {
      }
    ],
  • "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 -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": [
    • {
      }
    ],
  • "total": 130
}

Client IP

アプリケーションモニタリングプロジェクトで設定した時間中、遠隔クライアントIPを照会できるAPIです。 WhaTapは、クライアントに関する情報をデフォルトで保存します。

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 -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": [
    • {
      }
    ],
  • "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 -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": [
    • {
      }
    ],
  • "total": 1080
}

Heap使用量 - 統計平均値

アプリケーションモニタリングプロジェクトで設定した時間中、Heap使用量に対する統計平均値を照会できるAPIです。 照会時間は1時間以内に制限し、ミリ秒(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 -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": [
    • {
      },
    • {
      }
    ]
}

Heap使用量 - 統計最大値

アプリケーションモニタリングプロジェクトで設定した時間中、Heap使用量に対する統計最大値を照会できるAPIです。 照会時間は1時間以内に制限し、ミリ秒(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 -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": [
    • {
      },
    • {
      }
    ]
}

エージェントデータ照会

アプリケーションモニタリングプロジェクトで設定した時間中、エージェント全体のデータを照会できる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 -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": [
    • {
      },
    • {
      }
    ]
}

エージェント平均データ照会

アプリケーションモニタリングプロジェクトで設定した時間中、エージェント全体の平均データを照会できる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 -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": [
    • [
      ],
    • [
      ],
    • [
      ]
    ]
}

指定エージェントデータ照会

アプリケーションモニタリングプロジェクトで設定した時間中、指定したエージェント(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 -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": [
    • {
      },
    • {
      }
    ]
}

指定エージェント平均データ照会

アプリケーションモニタリングプロジェクトで設定した時間中、指定したエージェント(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 -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": [
    • [
      ],
    • [
      ],
    • [
      ]
    ]
}

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 -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": [
    • [
      ],
    • [
      ]
    ],
  • "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 -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": [
    • [
      ],
    • [
      ]
    ],
  • "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 -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": [
    • [
      ],
    • [
      ],
    • [
      ]
    ],
  • "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 -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": [
    • {
      },
    • {
      }
    ],
  • "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 -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 -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 -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

平均応答時間

アプリケーションモニタリングプロジェクトで設定した時間中、平均リスポンスタイムを照会できる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 -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

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 -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数

アプリケーションモニタリングプロジェクトで設定した時間中、データソース別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 -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": [
    • {
      }
    ]
}

データソースあたりの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 -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": [
    • {
      },
    • {
      }
    ]
}

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

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情報照会

サーバーモニタリングプロジェクトのエージェント情報および関連指標を照会できる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 -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"
}

非アクティブ状態のエージェント数の照会

サーバーモニタリングプロジェクトで非活性化状態のエージェント数を照会できる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 -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) 数

サーバーモニタリングプロジェクトに接続されたホスト(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 -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"
}

ホスト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 -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使用率

サーバーモニタリングプロジェクトに接続されたホスト(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 -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"
}

ディスク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 -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"
}

ネットワークトラフィック（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 -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"
}

プロセス状況

サーバモニタリングプロジェクトに接続されたホスト(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 -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": [
      ]
    }
}

サーバーリスト

サーバーモニタリングプロジェクトのサーバー一覧を照会できる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 -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": [
    • {
      },
    • {
      },
    • {
      }
    ],
  • "language": "en"
}

サーバーモニタリングの詳細

サーバーモニタリングプロジェクトの各サーバー別の詳細情報を照会できるAPIです。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン {{PROJECT_API_TOKEN}}

x-whatap-pcode
required
string

プロジェクトコード {{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統計データの参照

サーバーモニタリングプロジェクトの統計データを照会できるAPIの一覧を案内します。

サーバー統計の詳細

サーバーモニタリングプロジェクトの統計データを照会できるAPIです。 照会時間は1時間以内に制限し、ミリ秒(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 -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": [
    • {
      }
    ]
}

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 -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": [
    • {
      },
    • {
      }
    ],
  • "baseTime": [
    • {
      },
    • {
      }
    ],
  • "comparisonTime": [
    • {
      },
    • {
      }
    ]
}

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 -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": [
    • {
      },
    • {
      }
    ],
  • "topN": 10,
  • "total": 129,
  • "retrievedStartTime": 1692921600000,
  • "retrievedEndTime": 1693007999000
}

MXQL Open API 的な使い方

MXQLを使用する方法は次のとおりです。

  • 直接MXQLクエリを作成してデータを表示する方法

  • 次の文書を使用して、「SaaSサービスで提供する事前に定義されたMXQLクエリの一覧」でデータを参照する方法

したがって、それぞれの場合に使用されるAPIのパスが異なります。

MXQL使用方法 API
直接MXQLクエリを作成する場合 MXQL text API
「SaaSサービスで提供する事前に定義されたMXQLクエリの一覧」を使用する場合、(次の文書参照) MXQL path API

OpenAPIの呼び出し時、ヘッダーに含まれる内容は次のとおりです。

区分 キー 設定値 備考
ヘッダー 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

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
[
  • {
    • "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

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
[
  • {
    • "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"
    }
]