HealthScoreQuery
{
"detailed_header": false,
"dimension_aggregation": "string",
"entity_uuid": "string",
"hs_type": "string",
"include_refs": false,
"include_statistics": false,
"limit": 0,
"metric_entity": "string",
"order_series_by": "string",
"pad_missing_data": false,
"patch_oper_status": false,
"pool_uuid": "string",
"result_format": "string",
"server": "string",
"start": "string",
"step": 0,
"stop": "string",
"summary": false,
"tenant_uuid": "string"
}Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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.
UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Metrics Types supported. 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.
Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Format of the data returned. 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.
Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.