Get Point In Time Data
Gives point-in-time metrics data
Gives last reported metric data for a given resource_type and resource_id. This can be raw value or life-time counter value. (use /key-info API to check which keys have 'is_point_in_time' as 'true'). A distinct metric is defined by combination of resource_type + site_id + node_id + resource_id + obj_id + metric_key.
Request
URI
POST
https://{api_host}/metrics/point-in-time/data
COPY
Request Body
Request for raw data
PointInTimeMetricsQuery
of type(s)
application/json
Required
This request body class requires all of the following:
InlinePointInTimeMetricsQuery0
{
"resource_ids": [
"string"
],
"resource_types": [
"string"
],
"keys": [
"string"
],
"sort_by": "string",
"sort_ascending": false,
"page_number": 0,
"page_size": 0,
"filters": [
{
"filter_field": "string",
"filter_operation": "string",
"value": "string"
}
],
"aggregation": {
"aggregation_dimension": "string",
"aggregation_function": "string"
}
}Authorization
This operation uses the following authorization methods.
Responses
200
OK
Returns
PointInTimeMetricsResponse
of type(s)
application/json
This response body class contains all of the following:
InlinePointInTimeMetricsResponse0 ,
InlinePointInTimeMetricsResponse1
{
"sort_by": "string",
"sort_ascending": false,
"resource_types": [
"string"
],
"results": [
{
"key": "string",
"description": "string",
"units": "string",
"result_count_per_key": 0,
"metrics_data": [
{
"obj_id": "string",
"resource_id": "string",
"resource_ref_id": "string",
"node_id": "string",
"site_id": "string",
"display_name": "string",
"timestamp": 0,
"value": "string"
}
],
"aggregation_details": {
"sites": 0,
"nodes": 0,
"resources": 0,
"objects": 0
}
}
]
}
default
Error Response
Returns
Error
of type(s)
application/json
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}
integer
error_code
Required
HTTP Status or Application error code
string
module_name
Optional
Module where the error happened
string
error_message
Required
Message describing the error
Code Samples
COPY
curl -X POST -H 'Content-Type: application/json' -d '{"keys":["string"],"resource_ids":["string"],"resource_types":["string"]}' https://{api_host}/metrics/point-in-time/data