MetricsDataResponse

MetricsDataResponse
MetricsDataResponse

Metrics data response

JSON Example
{
    "start_time": 0,
    "end_time": 0,
    "granularity": "string",
    "resource_type": "string",
    "is_status_metric": false,
    "results": [
        {
            "resource_id": "string",
            "resource_ref_id": "string",
            "site_id": "string",
            "display_name": "string",
            "key_results": [
                {
                    "key": "string",
                    "unit": "string",
                    "description": "string",
                    "results": [
                        {
                            "object_id": "string",
                            "node_id": "string",
                            "node_path": "string",
                            "node_name": "string",
                            "last_known_status": {
                                "time": 0,
                                "value": "string"
                            },
                            "data": [
                                {
                                    "time": 0,
                                    "value": "string"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
integer As int64 As int64
start_time
Optional

Epoch time in seconds. Actual start time of the data being reported

integer As int64 As int64
end_time
Optional

Epoch time in seconds. Actual end time of the data being reported

granularity
Optional

Granularity of the metrics data required. Defaults are based on below setting - -- If time-range is <= 12 hr, default to 5 min granularity. -- If time-range is > 12 hrs and <= 7 days, default to 1 hr granularity. -- If time-range is more than 7 days, default to 1 day granularity. If you are looking for more coarser value, use this field. E.g If ONE_HOUR is set, system will aggregate all the data points available within one hour and return the aggregated metric value. This field is not relevant (ignored) for "is_status" metrics.

Possible values are : FIVE_MINUTES, ONE_HOUR, ONE_DAY,
string
resource_type
Optional

Resource Type for which metric data was requested for. E.g. PolicyEdgeNode

boolean
is_status_metric
Optional

Set to 'true' when the response is for 'is_status_metric' keys. For these type of metrics, do not expect to see periodic datapoints. These are reported/plotted only when the value of such metrics changes/transitions. If there are no transitions to report in the requested interval (defined by start_time - end_time), 'data' will be empty, and the latest status can be retrieved from 'last_known_value'.

results
Optional

Collection of per resource metric results