POST /analytics/metrics/collection

/analytics/metrics/collection

Request

URI

POST

https://{api_host}/api/analytics/metrics/collection

COPY

Query Parameters

boolean

include_name

Optional

Include name in the REST references

boolean

include_refs

Optional

Include references instead of object UUIDs

integer

limit

Optional

Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

boolean

pad_missing_data

Optional

Pad time series data with null in case there is not metric data present.

string

start

Optional

Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

integer

step

Optional

Metrics time series returned with time points every time duration specified as step. Eg. if bandwidth is desired every 5 Secs then use step=5&metric_id=l4_client.avg_bandwidth.

string

stop

Optional

End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

string

X-CSRFToken

Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller with reject requests.

Request Body

MetricsQueryResponse Collections API

MetricsCollectionApiReq of type(s) application/json

Required

{
    "metric_requests": [
        {
            "aggregate_entity": false,
            "aggregate_obj_id": false,
            "asn": "string",
            "attack": "string",
            "browser": "string",
            "client_insights": "string",
            "country": "string",
            "detailed_header": false,
            "devtype": "string",
            "dimension_aggregation": "string",
            "dimension_filter_op": "string",
            "dimension_limit": 0,
            "dimension_sampling": 0,
            "dimensions": [
                "string"
            ],
            "entity_uuid": "string",
            "id": "string",
            "include_refs": false,
            "include_statistics": false,
            "ipgroup": "string",
            "lang": "string",
            "limit": 0,
            "metric_entity": "string",
            "metric_id": "string",
            "microservice_levels": 0,
            "obj_id": "string",
            "order_by": "string",
            "os": "string",
            "pad_missing_data": false,
            "page": 0,
            "page_size": 0,
            "pool_uuid": "string",
            "prediction": false,
            "result_format": "string",
            "sampling_level": "string",
            "server": "string",
            "serviceengine_uuid": "string",
            "start": "string",
            "step": 0,
            "stop": "string",
            "tenant_uuid": "string",
            "url": "string",
            "validate_data": false
        }
    ]
}

array of object

metric_requests

Optional

list of metrics queries

Responses

200

Returns MetricsCollectionApiRsp of type(s) application/json

"MetricsCollectionApiRsp Object"

series

Optional

list of metrics data series map

401

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/analytics/metrics/collection

On This Page

Description

Request

Query Parameters

Header Parameters

Request Body

Response

200 Response Body

Errors

Metrics Operations

POST

POST /analytics/metrics/collection