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

StreamFleetOverview

||View as Markdown|
Example request
1{
2  "heartbeat_interval_seconds": 42
3}
Example response
1{
2  "update": {
3    "overview": {
4      "overview": {
5        "offline": 42,
6        "inactive": 42,
7        "active": 42,
8        "total": 42
9      }
10    }
11  },
12  "timestamp": {
13    "seconds": 42,
14    "nanos": 42
15  }
16}

StreamFleetOverview provides real-time updates for fleet overview statistics Returns a continuous stream of fleet status distribution changes

Built with

StreamFleetOverviewRequest

Request
This endpoint expects an object.
heartbeat_interval_secondsinteger

Optional heartbeat interval in seconds (0 means no heartbeats) Heartbeats help detect connection issues and keep streams alive

StreamFleetOverviewResponse

Stream response
This endpoint returns an object.
updateobject
timestampobject
Timestamp when this update was generated