---
title: "list top sqls"
method: POST
path: "/api/v1/sql/stats"
tags: ["Sql"]
---

# list top sqls

`POST /api/v1/sql/stats`

list top sqls ordering by spcecific metrics

## Request body

- SqlSqlFilter
  - `database` string
  - `endTime` integer
  - `includeInnerSql` boolean
  - `keyword` string
  - `namespace` string, required
  - `obtenant` string, required
  - `outputColumns` string[]
  - `pageNum` integer
  - `pageSize` integer
  - `sortColumn` string
  - `sortOrder` string
  - `startTime` integer
  - `suspiciousOnly` boolean
  - `user` string

## Response `200`

OK

- object
  - `data` SqlSqlStatsList, required
    - `items` SqlSqlInfo[]
      - `causeType` integer
      - `clientIp` string
      - `dbId` integer
      - `dbName` string
      - `diagnoseInfo` SqlSqlDiagnoseInfo[]
        - `level` string
        - `reason` string
        - `ruleName` string
        - `suggestion` string
      - `effectiveTenantId` integer
      - `event` string
      - `executionStatistics` SqlSqlStatisticMetric[], required
        - `name` string, required
        - `value` number, required
      - `formatSqlId` string
      - `lastFailInfo` integer
      - `latencyStatistics` SqlSqlStatisticMetric[], required
        - `name` string, required
        - `value` number, required
      - `planId` integer
      - `querySql` string
      - `sid` integer
      - `sqlId` string
      - `subPlanCount` integer
      - `svrIp` string
      - `svrPort` integer
      - `tenantId` integer
      - `tenantName` string
      - `traceId` string
      - `txId` string
      - `userClientIp` string
      - `userId` integer
      - `userName` string
    - `totalCount` integer
  - `message` string, required
  - `successful` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

> 28 revisions in range; 1 could not be searched.

- **2024-02-27** `643ae3c8d824` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/changes/api/v1/sql/stats/post.md)

---

[API](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api.md) · [All operations](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oceanbase/oceanbase-dashboard-api/revisions/fa579fa6f72d/schema)