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",
            "key_results": [
                {
                    "key": "string",
                    "unit": "string",
                    "description": "string",
                    "results": [
                        {
                            "object_id": "string",
                            "node_id": "string",
                            "node_path": "string",
                            "node_name": "string",
                            "last_known_value": "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

MetricsGranularity
granularity
Optional

Enumeration of different granular data points supported by the system. Metrics data points are maintained at 5Mins, 1Hour and 1Day granularities.

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'.

array of MetricsResourceResultEntry
results
Optional

Collection of per resource metric results

Returned By