Open MCP Portaldocs
ReferenceAdmin

Usage of every gateway and server (platform admins and auditors)

GET/v1/admin/usage

As getTeamUsage, over every call; team narrows to one team's scope (an unknown team reports nothing).

Query Parameters

from?string

Start (inclusive), on the hour; default 7 days before to

Formatdate-time
to?string

End (exclusive), on the hour; default the start of the next hour

Formatdate-time
groupBy?string

team: the gateway's team (platform gateways are one row with key platform). day and hour are UTC buckets; hour allows at most 7 days.

Default"day"

Value in

  • "gateway"
  • "server"
  • "capability"
  • "team"
  • "principalKind"
  • "day"
  • "hour"
gateway?string

Gateway ID

Formatuuid
server?string

MCP server ID

Formatuuid
capability?string

Only calls of this capability (capability ID)

Formatuuid
principalKind?string

As CallPrincipal.kind

Value in

  • "api_key"
  • "oauth"
  • "service_account"
method?string

Only this MCP method (default every recorded method, lists included)

Value in

  • "tools/list"
  • "tools/call"
  • "prompts/list"
  • "prompts/get"
  • "resources/list"
  • "resources/templates/list"
  • "resources/read"
series?boolean

With a non-time groupBy, add per-day buckets (UsageRow.series) to each row

Defaultfalse
team?string

Team slug or ID (calls through its gateways, to its servers, or by its service accounts)

limit?integer
Range1 <= value <= 200
Default50

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/admin/usage"
{  "data": {    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "groupBy": "gateway",    "rolledUpTo": "2019-08-24T14:15:22Z",    "totals": {      "calls": 0,      "errors": 0,      "outcomes": {        "property1": 0,        "property2": 0      },      "p50LatencyMs": 0,      "p95LatencyMs": 0,      "requestBytes": 0,      "responseBytes": 0    },    "rows": [      {        "key": "string",        "label": "string",        "ref": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "slug": "string",          "name": "string",          "exists": true        },        "capability": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "exposedName": "string",          "server": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "slug": "string",            "name": "string",            "exists": true          }        },        "principalKind": "api_key",        "start": "2019-08-24T14:15:22Z",        "metrics": {          "calls": 0,          "errors": 0,          "outcomes": {            "property1": 0,            "property2": 0          },          "p50LatencyMs": 0,          "p95LatencyMs": 0,          "requestBytes": 0,          "responseBytes": 0        },        "series": [          {            "start": "2019-08-24T14:15:22Z",            "metrics": {              "calls": 0,              "errors": 0,              "outcomes": {                "property1": 0,                "property2": 0              },              "p50LatencyMs": 0,              "p95LatencyMs": 0,              "requestBytes": 0,              "responseBytes": 0            }          }        ]      }    ],    "truncated": true  }}