GET
/v1/workspace/api-keys/{keyId}/usageRead workspace api-keys keyId usage
What one key has actually been doing: calls per route over a window, the failure classes, the clients and the people behind them. route, client and class narrow it, and the route breakdown is the paged list. A key id belonging to another workspace is a not-found. Admin and Enterprise only.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
keyIdpath · stringrequired
bodyquery · nulloptional
paramsquery · objectoptional
:keyIdstringoptional
queryquery · objectoptional
accountstringoptional
classstringoptional
clientstringoptional
cursorstringoptional
limitintegeroptional
routestringoptional
sincestringoptional
sortstringoptional
tenantintegeroptional
untilstringoptional
Responses
200application/json
the action's answer
{
"data": {
"answer": {
"filters": {},
"retention": "string",
"since": "string",
"sink": "string",
"total": 1.5,
"truncated": true
},
"failures": [
{
"count": 1.5,
"failures": 1.5,
"lastSeen": "string",
"value": "string"
}
],
"key": {
"id": "",
"lastUsedAt": "string"
},
"perDay": [
{
"count": 1.5,
"day": "string",
"failures": 1.5
}
],
"routes": [
{
"count": 1.5,
"failures": 1.5,
"lastSeen": "string",
"value": "string"
}
]
}
}datarequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired