Skip to main content
GET
List the most used tools
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/tools/listMostUsed?limit= lists the tools called most in the last seven days, most calls first. Like the Console, it counts tools of any status.

Authority

You need tools:read at the platform scope. An unavailable store is a 500. A repeated or out-of-range parameter is 400 bad_request.

What it returns

Each row is a toolId and its callCount. limit is how many of the top tools to answer, 1-20 (default 5); a larger value is 400 too_big. The answer is always the whole top limit: meta.hasMore is false, there is no cursor, and there is no meta.partial. It ranks the newest 500 calls of the seven days (fewer when its read budget stops first), so on a busier catalog older calls in the window are not counted.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:5

How many of the top items to answer, 1 to 20 (default 5); a larger value is a 400 too_big. The list is bounded: at most 20 items, the top limit tools by calls, ranked over the newest 500 calls of the last seven days. Every answer is the whole list, so meta.hasMore is false.

Required range: 1 <= x <= 20
cursor
string

A bounded list issues no cursor: meta.nextCursor is always null, and any cursor is 400.

Minimum string length: 1

Response

List the most used tools

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.