Telemetry
Telemetry API endpoints
GET
/api/fleet-benchmarkAuthorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Response Body
application/json
application/json
application/json
curl -X GET "http://localhost:3013/api/fleet-benchmark"{
"state": "ready",
"local": {
"tasksPerWeek": 0,
"taskSuccessRate": 0,
"finishedTasks": 0,
"agents": 0,
"bucket": "1"
},
"minFinishedTasks": 0,
"generatedAt": "string",
"comparisons": [
{
"key": "tasksPerWeek",
"value": 0,
"p50": 0,
"band": "top_10",
"peers": "1",
"installs": 0
}
]
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}POST
/api/telemetry/enableAuthorization
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
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:3013/api/telemetry/enable" \ -H "Content-Type: application/json" \ -d '{}'{
"enabled": true
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}POST
/api/telemetry/ui-eventAuthorization
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
application/json
application/json
application/json
curl -X POST "http://localhost:3013/api/telemetry/ui-event" \ -H "Content-Type: application/json" \ -d '{ "event": "string" }'Empty
{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}POST
/api/used-byAuthorization
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.
granted*boolean
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:3013/api/used-by" \ -H "Content-Type: application/json" \ -d '{ "granted": true }'{
"granted": true,
"changedAt": "string"
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}