For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • API Reference
        • UNARYGetFleetPerformance
        • STREAMStreamFleetOverview
        • STREAMStreamPerformanceMetrics
LogoLogo
API Referencefleetperformance.v1FleetPerformanceService

GetFleetPerformance

||View as Markdown|
Example request
1{}
Example response
1{
2  "fleet_performance": {
3    "overview": {
4      "offline": 42,
5      "inactive": 42,
6      "active": 42,
7      "total": 42
8    },
9    "hashrate": {
10      "stats": [
11        {
12          "value": {
13            "formatted_value": "example"
14          },
15          "label": "example",
16          "description": "example"
17        }
18      ],
19      "data": [
20        {
21          "timestamp": {
22            "seconds": 42,
23            "nanos": 42
24          },
25          "value": 42,
26          "unit": 0
27        }
28      ]
29    },
30    "efficiency": {
31      "stats": [
32        {
33          "value": {
34            "formatted_value": "example"
35          },
36          "label": "example",
37          "description": "example"
38        }
39      ],
40      "data": [
41        {
42          "timestamp": {
43            "seconds": 42,
44            "nanos": 42
45          },
46          "value": 42,
47          "unit": 0
48        }
49      ]
50    },
51    "power_usage": {
52      "stats": [
53        {
54          "value": {
55            "formatted_value": "example"
56          },
57          "label": "example",
58          "description": "example"
59        }
60      ],
61      "data": [
62        {
63          "timestamp": {
64            "seconds": 42,
65            "nanos": 42
66          },
67          "value": 42,
68          "unit": 0
69        }
70      ]
71    },
72    "uptime": {
73      "stats": [
74        {
75          "value": {
76            "formatted_value": "example"
77          },
78          "label": "example",
79          "description": "example"
80        }
81      ],
82      "data": [
83        {
84          "timestamp": {
85            "seconds": 42,
86            "nanos": 42
87          },
88          "value": 42,
89          "unit": 0
90        }
91      ]
92    }
93  }
94}
GetFleetPerformance retrieves comprehensive performance metrics for the entire fleet Returns aggregated statistics and time series data for various performance indicators
Built with

GetFleetPerformanceRequest

Request
This endpoint expects an object.

GetFleetPerformanceResponse

Response
This endpoint returns an object.
fleet_performanceobject
Fleet performance data containing all metrics