Skip to navigation

StreamPerformanceMetrics

View as Markdown

StreamPerformanceMetrics provides real-time updates for specific performance metrics Returns a continuous stream of metric updates for subscribed performance types

StreamPerformanceMetricsRequest

Request
This endpoint expects an object.
metric_typeslist of enums
Types of performance metrics to stream If empty, streams all performance metric types
Allowed values:
include_statsboolean
Whether to include statistical summaries in updates If true, includes updated Stat arrays when statistics change
include_measurementsboolean
Whether to include individual measurement data points If true, includes new Measurement data as it becomes available
heartbeat_interval_secondsinteger

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

StreamPerformanceMetricsResponse

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