Avi Object API

More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. post /analytics/metrics/collection/
  2. get /analytics/metrics/controller/
  3. get /analytics/metrics/controller/{uuid}
  4. get /analytics/metrics/pool/
  5. get /analytics/metrics/pool/{uuid}
  6. get /analytics/metrics/serviceengine/
  7. get /analytics/metrics/serviceengine/{uuid}
  8. get /analytics/metrics/virtualservice/
  9. get /analytics/metrics/virtualservice/{uuid}
Up 
post /analytics/metrics/collection/
(analyticsMetricsCollectionPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — MetricsQueryResponse Collections API

Query parameters

include_name (optional)
Query Parameter — Include name in the REST references
include_refs (optional)
Query Parameter — Include references instead of object UUIDs
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.
pad_missing_data (optional)
Query Parameter — Pad time series data with null in case there is not metric data present.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.
step (optional)
Query Parameter — 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.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

Return type

MetricsCollectionApiRsp

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsCollectionApiRsp

401

log in failed
Up 
get /analytics/metrics/controller/
(analyticsMetricsControllerGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
name (optional)
Query Parameter — object name
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponseApiResponse

401

log in failed
Up 
get /analytics/metrics/controller/{uuid}
(analyticsMetricsControllerUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json
{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponse

401

log in failed
Up 
get /analytics/metrics/pool/
(analyticsMetricsPoolGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
name (optional)
Query Parameter — object name
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponseApiResponse

401

log in failed
Up 
get /analytics/metrics/pool/{uuid}
(analyticsMetricsPoolUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json
{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponse

401

log in failed
Up 
get /analytics/metrics/serviceengine/
(analyticsMetricsServiceengineGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
name (optional)
Query Parameter — object name
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponseApiResponse

401

log in failed
Up 
get /analytics/metrics/serviceengine/{uuid}
(analyticsMetricsServiceengineUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json
{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponse

401

log in failed
Up 
get /analytics/metrics/virtualservice/
(analyticsMetricsVirtualserviceGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
name (optional)
Query Parameter — object name
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponseApiResponse

401

log in failed
Up 
get /analytics/metrics/virtualservice/{uuid}
(analyticsMetricsVirtualserviceUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
aggregate_entity (optional)
Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Query Parameter — Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
Query Parameter — Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
Query Parameter — Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
Query Parameter — Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
Query Parameter — Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
Query Parameter — Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
Query Parameter — Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_sampling (optional)
Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimensions (optional)
Query Parameter — Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
Query Parameter — ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
Query Parameter — IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
Query Parameter — Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Query Parameter — number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
Query Parameter — serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
Query Parameter — Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Query Parameter — page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page_size (optional)
Query Parameter — page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Query Parameter — Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
Query Parameter — URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json
{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MetricsQueryResponse

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. MetricStatistics
  2. MetricsCollectionApiReq
  3. MetricsCollectionApiRsp
  4. MetricsData
  5. MetricsDataHeader
  6. MetricsDataSeries
  7. MetricsDerivationData
  8. MetricsDimensionData
  9. MetricsFilters
  10. MetricsMissingDataInterval
  11. MetricsQuery
  12. MetricsQueryApiResponse
  13. MetricsQueryResponse
  14. MetricsQueryResponseApiResponse
  15. RelationalOperatorsParams

MetricStatistics Up

last_sample (optional)
Double value of the last sample. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
max (optional)
Double maximum value in time series requested. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
max_ts (optional)
String timestamp of the minimum value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mean (optional)
Double arithmetic mean. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
min (optional)
Double minimum value in time series requested. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
min_ts (optional)
String timestamp of the minimum value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_samples (optional)
Integer Number of actual data samples. It excludes fake data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
sum (optional)
Double summation of all values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
trend (optional)
Double slope of the data points across the time series requested. trend = (last_value - avg)/avg. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

MetricsCollectionApiReq Up

metric_requests (optional)
array[MetricsQuery] list of metrics queries

MetricsCollectionApiRsp Up

MetricsData Up

application_response_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
blocking_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
browser_rendering_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
client_rtt (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
connection_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
dns_lookup_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
dom_content_load_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
is_null (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_samples (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
page_download_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
page_load_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
prediction_interval_high (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
prediction_interval_low (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
redirection_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
rum_client_data_transfer_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
server_rtt (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
service_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
timestamp (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
value_str (optional)
String Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value_str_desc (optional)
String Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
waiting_time (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

MetricsDataHeader Up

derivation_data (optional)
MetricsDerivationData Metrics derivation info. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_data (optional)
array[MetricsDimensionData] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
String entity uuid. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metrics_min_scale (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
metrics_sum_agg_invalid (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
missing_intervals (optional)
array[MetricsMissingDataInterval] Missing data intervals. data in these intervals are not used for stats calculation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String name of the column. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id (optional)
String object ID of the series when object ID was specified in the metric. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_id_type (optional)
String obj_id_type. Enum options - METRICS_OBJ_ID_TYPE_VIRTUALSERVICE, METRICS_OBJ_ID_TYPE_SERVER, METRICS_OBJ_ID_TYPE_POOL, METRICS_OBJ_ID_TYPE_SERVICEENGINE, METRICS_OBJ_ID_TYPE_VIRTUALMACHINE, METRICS_OBJ_ID_TYPE_CONTROLLER, METRICS_OBJ_ID_TYPE_TENANT, METRICS_OBJ_ID_TYPE_CLUSTER, METRICS_OBJ_ID_TYPE_SE_INTERFACE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
String pool_id for the metric. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
priority (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
String server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
String Service Engine ref or UUID. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
statistics (optional)
MetricStatistics statistics of the metric. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
String Tenant ref or UUID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
units (optional)
String units of the column data. Enum options - METRIC_COUNT, BITS_PER_SECOND, MILLISECONDS, SECONDS, PER_SECOND, BYTES, PERCENT, KILO_BYTES, KILO_BYTES_PER_SECOND, BYTES_PER_SECOND, KILO_BITS_PER_SECOND, GIGA_BYTES, MEGA_BYTES, NORMALIZED, STRING, SEC, MIN, DAYS, KB, MB, GB, MBPS, GHZ, RATIO, WORD, MICROSECONDS, HEALTH, HOURS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsDataSeries Up

data (optional)
array[MetricsData] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
header
MetricsDataHeader Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsDerivationData Up

derivation_fn
String Enum options - METRICS_ALIAS, SUM_FIRST_N_DIVIDE_BY_LAST, SUM_BW_GAUGE, AVG_GET_POST_OTHER_LATENCY, APPDEX_ON_3_BUCKETS, APPDEX_ON_4_BUCKETS, SUM_GAUGE, SUM_N_METRICS, APPDEX_ON_5_BUCKETS, APPDEX_ON_6_BUCKETS, APPDEX_ON_CONNECTIONS, APPDEX_ON_2_BUCKETS, AVG_CLIENT_LATENCY, AVG_APPLICATION_LATENCY, MIN_N_METRICS, SUM_FIRST_N_DIVIDE_BY_LAST_PERCENTAGE, L4_CONNECTION_ERROR_PERCENTAGE, AVG_L4_CLIENT_LATENCY, CHECK_FOR_TRANSITIONS, SUBSTRACT_ALL_FROM_FIRST, AVG_N_OVER_TIME_PERIOD, AVG_NAVIGATION_TIMING, AVG_RUM_VISITS, PCT_SSL_ERROR_CONNECTIONS, AVG_RESPONSE_TIME, SUM_RATES_FIRST_N_DIVIDE_BY_LAST, SUM_RATES_FIRST_N_DIVIDE_BY_LAST_PERCENTAGE, PCT_CACHE_METRICS, SUM_FIRST_N_DIVIDE_BY_SECLAST_EXCL_ERROR_RATE, SUM_FIRST_N_SUBSTRACT_LAST, AVG_POOL_METRICS, AVG_POOL_BW, AVG_BY_SUBSTRACT_ALL_FROM_FIRST_OVER_TIME, AVG_RSA_PFS, EVAL_FN, SSL_PROTOCOL_INDICATOR, SUM_FIRST_N_DIVIDE_BY_SECLAST_RATE_EXCL_ERROR_RATE, SUBSTRACT_ALL_FROM_FIRST_WITH_FLOOR_ZERO, AVAILABLE_CAPACITY, CONNECTION_SATURATION, AVG_RSA_NON_PFS, SSL_HANDSHAKES_NONPFS, DYN_MEM_USAGE, FIRST_DIVIDE_BY_DIFFERENCE_OF_SECOND_AND_THIRD, DIVIDE_BY_100. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
exclude_derived_metric (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_derivation_metrics (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
join_tables (optional)
String Enum options - METRICS_TABLE_NONE, METRICS_TABLE_ANOMALY, METRICS_TABLE_CONTROLLER_STATS, METRICS_TABLE_HEALTH_SCORE, METRICS_TABLE_SE_STATS, METRICS_TABLE_VSERVER_L4_SERVER, METRICS_TABLE_VSERVER_L4_CLIENT, METRICS_TABLE_VSERVER_L7_CLIENT, METRICS_TABLE_VSERVER_L7_SERVER, METRICS_TABLE_RUM_PREAGG_BROWSER, METRICS_TABLE_RUM_PREAGG_COUNTRY, METRICS_TABLE_RUM_PREAGG_DEVTYPE, METRICS_TABLE_RUM_PREAGG_LANG, METRICS_TABLE_RUM_PREAGG_OS, METRICS_TABLE_RUM_PREAGG_URL, METRICS_TABLE_RUM_ANALYTICS, METRICS_TABLE_VM_STATS, METRICS_TABLE_RESOURCE_TIMING_DIM, METRICS_TABLE_RESOURCE_TIMING_BLOB, METRICS_TABLE_RUM_PREAGG_IPGROUP, METRICS_TABLE_DOS_ANALYTICS, METRICS_TABLE_APP_INSIGHTS, METRICS_TABLE_VSERVER_DNS, METRICS_TABLE_SERVER_DNS, METRICS_TABLE_SERVICE_INSIGHTS, METRICS_TABLE_SOURCE_INSIGHTS, METRICS_TABLE_TENANT_STATS, METRICS_TABLE_SE_IF_STATS, METRICS_TABLE_USER_METRICS, METRICS_TABLE_WAF_GROUP, METRICS_TABLE_WAF_TAG, METRICS_TABLE_WAF_RULE, METRICS_TABLE_PROCESS_STATS, METRICS_TABLE_VSERVER_HTTP2_CLIENT, METRICS_TABLE_PG_STAT_DATABASE, METRICS_TABLE_PG_STAT_ALL_TABLES, METRICS_TABLE_PG_STAT_ALL_INDEXES, METRICS_TABLE_PG_STAT_IO_ALL_TABLES, METRICS_TABLE_PG_STAT_CLASS, METRICS_TABLE_PG_STAT_BG_WRITER, METRICS_TABLE_WAF_WHITELIST, METRICS_TABLE_WAF_PSMGROUP, METRICS_TABLE_WAF_PSMLOCATION, METRICS_TABLE_WAF_PSMRULE, METRICS_TABLE_GSLB_STATS, METRICS_TABLE_VS_SCALEOUT, METRICS_TABLE_API_PERF_STATS, METRICS_TABLE_NSXT_STATS, METRICS_TABLE_ICAP, METRICS_TABLE_BOT, METRICS_TABLE_SEGROUP_STATS, METRICS_TABLE_ENVOY_UPSTREAM_STATS, METRICS_TABLE_ENVOY_DOWNSTREAM_STATS, METRICS_TABLE_REDIS_QUEUE_STATS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_ids
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_has_additional_fields (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
second_order_derivation (optional)
Boolean Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
skip_backend_derivation (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsDimensionData Up

dimension
String Dimension Type. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_id
String Dimension ID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsFilters Up

op
String Enum options - EQ, GT, GE, LT, LE, NE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rel_param
RelationalOperatorsParams Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsMissingDataInterval Up

end
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsQuery Up

aggregate_entity (optional)
Boolean Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
aggregate_obj_id (optional)
Boolean Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
asn (optional)
String Autonomous System number. Eg. asn=3794. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attack (optional)
String Dos Attack ID filter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
browser (optional)
String Browser filter. Eg. browser=Chrome. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_insights (optional)
String Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
String Two letter country filter. Eg. country=US. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
detailed_header (optional)
Boolean Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
devtype (optional)
String Device type filter. Eg. devtype=desktop. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_aggregation (optional)
String Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_filter_op (optional)
String Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dimension_limit (optional)
Integer Limit the number of dimensions in the result. specially useful in case of URLs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
dimension_sampling (optional)
Integer Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
dimensions (optional)
array[String] Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
String UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
String ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Boolean Resolve UUID to names. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Boolean Include metrics statistics with the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipgroup (optional)
String IPGROUP filter Eg. UUID of the IP group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
lang (optional)
String Language filter. Eg. lang=english. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Integer Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
metric_entity (optional)
String Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
String Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
microservice_levels (optional)
Integer number of levels of microservices map. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
obj_id (optional)
String serverip port of the pool server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_by (optional)
String Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
os (optional)
String Operating system filter. Eg. os=mac. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Boolean Pad missing data when not available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page (optional)
Integer page id for the query. Allowed only for aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
page_size (optional)
Integer page size of the query. Allowed only for the aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
pool_uuid (optional)
String metrics for a member pool in a virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prediction (optional)
Boolean Request prediction values instead of actual observed metrics in future if supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
String Deprecated. Please do not use this option. APIs only support JSON format. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sampling_level (optional)
String Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
String Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_uuid (optional)
String UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
String Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Integer 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
stop (optional)
String End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
String UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String URL filter. Eg. url=http //www.avinetworks.com. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_data (optional)
Boolean Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricsQueryApiResponse Up

count
Integer format: int32
results
array[MetricsQuery]
next (optional)
String

MetricsQueryResponse Up

entity_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
id (optional)
String returns the ID specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
metric_entity (optional)
String Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
series (optional)
array[MetricsDataSeries] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
stop (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url

MetricsQueryResponseApiResponse Up

count
Integer format: int32
results
array[MetricsQueryResponse]
next (optional)
String

RelationalOperatorsParams Up

entity_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_id
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
right_arg
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.