本文へスキップ
API docs by Redocly

WhaTap Open API v2 (2.0)

Open API v2

プロジェクトのAPM統計データを照会します。指定した時間範囲内でサービスごとに集計されたトランザクション、SQL、HTTP外部呼び出し、Exception、Client IP統計を返します。

Base URL

  • SaaS: https://api.whatap.io
  • Self-hosted: デプロイ環境によって異なります（例: https://{your-domain}）

認証

すべてのリクエストに次のヘッダーが必要です。

ヘッダー タイプ 説明
x-whatap-token string プロジェクトAPIトークン
x-whatap-pcode string プロジェクトコード

統計タイプ

タイプ 説明 フィルターサポート
transaction トランザクション（サービス）統計 -
sql SQL実行統計 -
httpc HTTP外部呼び出し統計 host, port
error Exception統計 -
remote Client IP統計 -

デフォルトのソート順序

orderを省略すると、タイプごとに次のカラム基準で降順ソートします。

タイプ デフォルトソート
transaction timeSum
sql timeAvg
httpc timeSum
error count
remote count

制限事項

項目 値 説明
最大時間範囲 24時間 etime - stimeは86,400,000msを超えることはできません。
最大レコード数 10,000 サーバー設定open_api_max_recordsのデフォルト値です。超過した場合、total > retrievedTotalで確認できます。

参考事項

  • ハッシュ(Hash)フィールドは符号付き整数であり、負の値になる場合があります。
  • 統計は5分単位のキューブデータから集計します。サーバーが内部的に時間境界を整列します。
  • etimeが現在のサーバー時間を超過すると、自動的に現在の時間に補正します。実際の照会範囲がリクエストより狭くなる場合があります。
  • totalがretrievedTotalより大きい場合、最大レコード数の制限により結果が切り捨てられています。全データを照会するには、時間範囲を狭めてください。
  • ページ番号やoffsetによるページネーションはサポートしていません。結果は最大レコード数まで単一ページで返されます。

APM統計照会

トランザクション統計照会

設定した期間に発生したトランザクション内訳を照会します。サービス（URLパターン）基準で集計します。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン

x-whatap-pcode
required
string

プロジェクトコード

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

照会開始時間です。UNIX epoch time(millisecond)単位です。

etime
required
integer <int64>

照会終了時間です。UNIX epoch time(millisecond)単位であり、etime - stimeは86,400,000ms（24時間）を超えることはできません。

order
string

ソート基準カラムです。省略するとtimeSum基準で降順ソートします。

Responses

Response Schema: application/json
stime
integer

照会開始時間(millisecond)

etime
integer

照会終了時間(millisecond)

timestamp
integer

サーバーがレスポンスを生成した時間(millisecond)

Array of objects (TransactionRecord)
total
integer

条件に一致する全レコード数

retrievedTotal
integer

実際に返されたレコード数

Request samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000
}

Response samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000,
  • "timestamp": 1772591844544,
  • "data": [
    • {
      }
    ],
  • "total": 1210,
  • "retrievedTotal": 1210
}

SQL統計照会

設定した期間に実行されたSQL内訳を照会します。SQL文およびDB Connection基準で集計します。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン

x-whatap-pcode
required
string

プロジェクトコード

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

照会開始時間です。UNIX epoch time(millisecond)単位です。

etime
required
integer <int64>

照会終了時間です。UNIX epoch time(millisecond)単位であり、etime - stimeは86,400,000ms（24時間）を超えることはできません。

order
string

ソート基準カラムです。省略するとtimeAvg基準で降順ソートします。

Responses

Response Schema: application/json
stime
integer
etime
integer
timestamp
integer
Array of objects (SqlRecord)
total
integer
retrievedTotal
integer

Request samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000
}

Response samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000,
  • "timestamp": 1772591844612,
  • "data": [
    • {
      }
    ],
  • "total": 121,
  • "retrievedTotal": 121
}

HTTP外部呼び出し統計照会

設定した期間に発生したHTTP外部呼び出し内訳を照会します。URLおよびホスト基準で集計します。

httpcタイプはホストとポートでフィルタリングできます。フィルターを省略すると全レコードを返します。フィルターを指定する場合、hostとportを両方含める必要があります。

参考 — フィルター適用時、totalフィールドはフィルター条件に一致するレコード数を反映します。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン

x-whatap-pcode
required
string

プロジェクトコード

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

照会開始時間(millisecond)

etime
required
integer <int64>

照会終了時間(millisecond)

order
string

ソート基準カラムです。省略するとtimeSum基準で降順ソートします。

object

ホストとポートでフィルタリングします。指定する場合、hostとportを両方含める必要があります。

Responses

Response Schema: application/json
stime
integer
etime
integer
timestamp
integer
Array of objects (HttpcRecord)
total
integer
retrievedTotal
integer

Request samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000,
  • "filter": {
    • "host": "api.example",
    • "port": "443"
    }
}

Response samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000,
  • "timestamp": 1772591844703,
  • "data": [
    • {
      }
    ],
  • "total": 6260,
  • "retrievedTotal": 6260
}

Exception統計照会

設定した期間に発生したException内訳を照会します。Exceptionクラスおよびメッセージ基準で集計します。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン

x-whatap-pcode
required
string

プロジェクトコード

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

照会開始時間(millisecond)

etime
required
integer <int64>

照会終了時間(millisecond)

order
string

ソート基準カラムです。省略するとcount基準で降順ソートします。

Responses

Response Schema: application/json
stime
integer
etime
integer
timestamp
integer
Array of objects (ErrorRecord)
total
integer
retrievedTotal
integer

Request samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000
}

Response samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000,
  • "timestamp": 1772591844811,
  • "data": [
    • {
      }
    ],
  • "total": 1041,
  • "retrievedTotal": 1041
}

Client IP統計照会

設定した期間にアクセスしたClient IP統計を照会します。GeoIP情報を含みます。

header Parameters
x-whatap-token
required
string

プロジェクトAPIトークン

x-whatap-pcode
required
string

プロジェクトコード

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

照会開始時間(millisecond)

etime
required
integer <int64>

照会終了時間(millisecond)

order
string

ソート基準カラムです。省略するとcount基準で降順ソートします。

Responses

Response Schema: application/json
stime
integer
etime
integer
timestamp
integer
Array of objects (RemoteRecord)
total
integer
retrievedTotal
integer

Request samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000
}

Response samples

Content type
application/json
{
  • "stime": 1771545600000,
  • "etime": 1771545900000,
  • "timestamp": 1772591844850,
  • "data": [
    • {
      }
    ],
  • "total": 4335,
  • "retrievedTotal": 4335
}