Get Point In Time 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')
Request
URI
POST
https://api_host/napp/api/v1/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
Show optional properties
{
"resource_ids": [
"string"
],
"resource_types": [
"string"
],
"keys": [
"string"
]
}
{
"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"
}
}
Responses
200
OK
Returns PointInTimeMetricsResponse of type(s) application/json
This response body class contains all of the following: PointInTimeMetricsListResult , 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",
"node_id": "string",
"site_id": "string",
"instance_id": "string",
"org_id": "string",
"display_name": "string",
"timestamp": 0,
"value": "string"
}
],
"aggregation_details": {
"sites": 0,
"nodes": 0,
"resources": 0,
"objects": 0
}
}
]
}
400
Invalid Input
Operation doesn't return any data structure
Availability
Added in 4.2
Metrics Operations
GET
Get Metric Keys Information Per Resource Type
GET
Get Metrics Data Collection
POST
Get Object Information
POST
Get Point In Time Data
POST
Get Time Series Data
POST
Update Metrics Data Collection