GetCombinedMetrics | Proto Fleet Documentation

{
  "device_selector": {
    "selector_value": {
      "all_devices": true
    }
  },
  "measurement_types": [
    0
  ],
  "aggregations": [
    0
  ],
  "granularity": {
    "seconds": 42,
    "nanos": 42
  },
  "start_time": {
    "seconds": 42,
    "nanos": 42
  },
  "end_time": {
    "seconds": 42,
    "nanos": 42
  },
  "page_token": "example",
  "page_size": 42
}

{
  "metrics": [
    {
      "measurement_type": 0,
      "open_time": {
        "seconds": 42,
        "nanos": 42
      },
      "aggregated_values": [
        {
          "aggregation_type": 0,
          "value": 42
        }
      ],
      "device_count": 42
    }
  ],
  "next_page_token": "example",
  "temperature_status_counts": [
    {
      "timestamp": {
        "seconds": 42,
        "nanos": 42
      },
      "cold_count": 42,
      "ok_count": 42,
      "hot_count": 42,
      "critical_count": 42
    }
  ],
  "uptime_status_counts": [
    {
      "timestamp": {
        "seconds": 42,
        "nanos": 42
      },
      "hashing_count": 42,
      "not_hashing_count": 42
    }
  ]
}

{
  "device_selector": {
    "selector_value": {
      "all_devices": true
    }
  },
  "measurement_types": [
    0
  ],
  "aggregations": [
    0
  ],
  "granularity": {
    "seconds": 42,
    "nanos": 42
  },
  "start_time": {
    "seconds": 42,
    "nanos": 42
  },
  "end_time": {
    "seconds": 42,
    "nanos": 42
  },
  "page_token": "example",
  "page_size": 42
}

{
  "metrics": [
    {
      "measurement_type": 0,
      "open_time": {
        "seconds": 42,
        "nanos": 42
      },
      "aggregated_values": [
        {
          "aggregation_type": 0,
          "value": 42
        }
      ],
      "device_count": 42
    }
  ],
  "next_page_token": "example",
  "temperature_status_counts": [
    {
      "timestamp": {
        "seconds": 42,
        "nanos": 42
      },
      "cold_count": 42,
      "ok_count": 42,
      "hot_count": 42,
      "critical_count": 42
    }
  ],
  "uptime_status_counts": [
    {
      "timestamp": {
        "seconds": 42,
        "nanos": 42
      },
      "hashing_count": 42,
      "not_hashing_count": 42
    }
  ]
}

Historical, aggregated candles (pull).

GetCombinedMetricsRequest

Request

This endpoint expects an object.

device_selectorobject

Select devices by ID or all devices in org

measurement_typeslist of enums

e.g., TEMPERATURE, HASHRATE Defaults to all types

aggregationslist of enums

e.g., AVERAGE, MIN, MAX Defaults to all aggregations

granularityobject

e.g., 1m, 5m, 1h defaults to 10s

start_timeobject

inclusive

end_timeobject

page_tokenstring

for pagination

page_sizeinteger

max 1000, default 100

GetCombinedMetricsResponse

Response

This endpoint returns an object.

metricslist of objects

next_page_tokenstring

for pagination

temperature_status_countslist of objects

Temperature status distribution across the fleet

uptime_status_countslist of objects

Uptime status distribution across the fleet

1	{
2	"device_selector": {
3	"selector_value": {
4	"all_devices": true
5	}
6	},
7	"measurement_types": [
8	0
9	],
10	"aggregations": [
11	0
12	],
13	"granularity": {
14	"seconds": 42,
15	"nanos": 42
16	},
17	"start_time": {
18	"seconds": 42,
19	"nanos": 42
20	},
21	"end_time": {
22	"seconds": 42,
23	"nanos": 42
24	},
25	"page_token": "example",
26	"page_size": 42
27	}

1	{
2	"metrics": [
3	{
4	"measurement_type": 0,
5	"open_time": {
6	"seconds": 42,
7	"nanos": 42
8	},
9	"aggregated_values": [
10	{
11	"aggregation_type": 0,
12	"value": 42
13	}
14	],
15	"device_count": 42
16	}
17	],
18	"next_page_token": "example",
19	"temperature_status_counts": [
20	{
21	"timestamp": {
22	"seconds": 42,
23	"nanos": 42
24	},
25	"cold_count": 42,
26	"ok_count": 42,
27	"hot_count": 42,
28	"critical_count": 42
29	}
30	],
31	"uptime_status_counts": [
32	{
33	"timestamp": {
34	"seconds": 42,
35	"nanos": 42
36	},
37	"hashing_count": 42,
38	"not_hashing_count": 42
39	}
40	]
41	}