Viewpoint System Metrics RESTful API Data Objects | Teradata Viewpoint - Data Objects - Teradata Data Lab - Teradata Viewpoint

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide - 24.04

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Lab
Teradata Viewpoint
Release Number
24.04
Published
April 2024
Language
English (United States)
Last Update
2024-04-29
dita:mapPath
qko1711972084905.ditamap
dita:ditavalPath
ft:empty
dita:id
prd1525780132746
Product Category
Analytical Ecosystem

MetricSourceWS

{
"metric_name": "Active Sessions", //Metric name
"metric_id": "ACTIVE_SESSIONS"   //Metric ID for given metric name
}

AggregatedTimebasedNumeric

{
"timestamp": 1624797540000, // Timestamp when the system metric was calculated "number": 1.25,
"max": 2,	// max value
"min": 1,	// min value
"avg": 1.25	// Average value
}

PortletMetricsDataMode

{
"title": "CPU System (sdl54560.labs.teradata)", // title of the metric
"variant_type": null,	//The default variant to
use for the metric
"units": "percent",	//The metric's units
"factor": null,	//This attribute related to export data "group": "percent",		//The metric's units "sparklineModel": {..},
"selected": false,	//This metric belong to selected metric "metricData": [...]
}

sparklineModel

{
"metric": "CPU_SYSTEM", //Metric ID for given metric
"threshold": null,	//The threshold value for the SLA line of the   "enabled": false,	//This value will always false for APIs
"metric_name": "CPU System",	//Metric name for given metricID 
"vertical_axis_max": null,	//This attribute is UI attributes
"unit_name": "percent",	//The metric's units
"unit_label": null	//i18n label for the unit
"system_id": 8,      //Internal ID of the monitored system 
"user_default_settings": false, // This attribute is UI attibutes value will be always false in APIs
"security_domain": null,
},