[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Fetch Bulk Metrics

Description

Get metric points for multiple entity ids and metric for a given time interval. All the entity ids should belong to the same entity type. Maximum number of metrics point per entity returned by API is configurable. Default is 300. In case the interval and time period combination have more than 300 metrics points, client should break the time period to multiple batches to get all the metrics points.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/metrics/fetch
Copy

Request Body

Request Body

MetricsBulkFetchRequest of type(s) application/json Required
{
	"end_time": 0,
	"entity_ids": [
		"string"
	],
	"interval": 0,
	"metric": "string",
	"start_time": 0
}
integer as int64
end_time Optional

array of string
entity_ids Optional

Entity Identifiers


integer
interval Optional

Metric resolution


string
metric Optional

Metric to fetch


integer as int64
start_time Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns MetricsBulkFetchResponse of type(s) application/json
{
	"display_name": "string",
	"end": 0,
	"interval": 0,
	"metric": "string",
	"results": [
		{
			"entity_id": "string",
			"pointlist": [
				0
			]
		}
	],
	"start": 0,
	"unit": "string"
}
string
display_name Optional

integer as int64
end Optional

integer as int32
interval Optional

string
metric Optional

results Optional

integer as int64
start Optional

string
unit Optional
Errors

Errors

400

Bad Request


401

Unauthorized


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"end_time":0,"entity_ids":["string"],"interval":0,"metric":"string","start_time":0}' https://vrni.example.com/api/ni/metrics/fetch


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Feedback

Was this page helpful?