MetricsDataHeader

MetricsDataHeader
MetricsDataHeader
JSON Example
{
    "derivation_data": {
        "derivation_fn": "string",
        "exclude_derived_metric": false,
        "include_derivation_metrics": false,
        "join_tables": "string",
        "metric_ids": "string",
        "result_has_additional_fields": false,
        "second_order_derivation": false,
        "skip_backend_derivation": false
    },
    "dimension_data": [
        {
            "dimension": "string",
            "dimension_id": "string"
        }
    ],
    "entity_uuid": "string",
    "metric_description": "string",
    "metrics_min_scale": "number",
    "metrics_sum_agg_invalid": false,
    "missing_intervals": [
        {
            "end": "string",
            "start": "string"
        }
    ],
    "name": "string",
    "obj_id": "string",
    "obj_id_type": "string",
    "pool_uuid": "string",
    "priority": false,
    "server": "string",
    "serviceengine_uuid": "string",
    "statistics": {
        "last_sample": "number",
        "max": "number",
        "max_ts": "string",
        "mean": "number",
        "min": "number",
        "min_ts": "string",
        "num_samples": 0,
        "sum": "number",
        "trend": "number"
    },
    "tenant_uuid": "string",
    "units": "string"
}
MetricsDerivationData
derivation_data
Optional

derivation_data

array of MetricsDimensionData
dimension_data
Optional

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

string
entity_uuid
Optional

entity uuid. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
metric_description
Optional

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

number As double As double
metrics_min_scale
Optional

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

boolean
metrics_sum_agg_invalid
Optional

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

array of MetricsMissingDataInterval
missing_intervals
Optional

Missing data intervals. data in these intervals are not used for stats calculation. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

name of the column. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
obj_id
Optional

object ID of the series when object ID was specified in the metric. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
obj_id_type
Optional

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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
pool_uuid
Optional

pool_id for the metric. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
priority
Optional
Constraints: default: true

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

string
server
Optional

server ip port. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
serviceengine_uuid
Optional

Service Engine ref or UUID. Field introduced in 17.2.8. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

MetricStatistics
statistics
Optional

statistics

string
tenant_uuid
Optional

Tenant ref or UUID. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
units
Optional
Constraints: default: METRIC_COUNT

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, NANOSECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of