Fetch Bulk Metrics

Fetch Bulk Metrics

This api is deprecated. Please use /metrics/fetch/v2. 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
URI
POST
https://{api_host}/api/ni/metrics/fetch
COPY
Request Body
MetricsBulkFetchRequest of type(s) application/json
Required
{
    "entity_ids": [
        "string"
    ],
    "start_time": 0,
    "end_time": 0,
    "interval": 0,
    "metric": "string"
}
array of string
entity_ids
Optional

Entity Identifiers

integer As int64 As int64
start_time
Optional

start_time

integer As int64 As int64
end_time
Optional

end_time

integer
interval
Optional

Metric resolution

string
metric
Optional

Metric to fetch

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MetricsBulkFetchResponse of type(s) application/json
This response body class contains all of the following: MetricsBulkFetchResponseBase , InlineMetricsBulkFetchResponse1
{
    "metric": "string",
    "interval": 0,
    "start": 0,
    "end": 0,
    "display_name": "string",
    "unit": "string",
    "results": [
        {
            "pointlist": [
                [
                    {}
                ]
            ],
            "entity_id": "string"
        }
    ]
}

400

Bad Request

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


401

Unauthorized

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure