Agent SwarmMetrics
Metrics API endpoints
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
agentId?string
Length
1 <= lengthlimit?integer
Range
1 <= value <= 500offset?|
Range
0 <= valuefields?string
Value in
"full" | "slim"Response Body
curl -X GET "http://localhost:3013/api/metrics/definitions"Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/metrics/definitions" \ -H "Content-Type: application/json" \ -d '{ "title": "string", "definition": { "version": 1, "widgets": [ { "id": "string", "title": "string", "query": { "sql": "string" }, "viz": { "type": "stat" } } ] } }'Empty
Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
Response Body
curl -X DELETE "http://localhost:3013/api/metrics/definitions/string"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
Response Body
curl -X GET "http://localhost:3013/api/metrics/definitions/string"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PUT "http://localhost:3013/api/metrics/definitions/string" \ -H "Content-Type: application/json" \ -d '{}'Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/metrics/definitions/string/run" \ -H "Content-Type: application/json" \ -d '{}'Empty
Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
Response Body
curl -X GET "http://localhost:3013/api/metrics/definitions/string/versions"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
version*integer
Range
1 <= valueResponse Body
curl -X GET "http://localhost:3013/api/metrics/definitions/string/versions/1"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Response Body
curl -X GET "http://localhost:3013/api/metrics/schema"Empty