Dashboard Reporting APIs | VantageCloud Lake - Dashboard Reporting APIs - Teradata Vantage

Teradata® VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Vantage
Published
January 2023
ft:locale
en-US
ft:lastEdition
2024-12-11
dita:mapPath
phg1621910019905.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
phg1621910019905

The APIs documented in this section are suitable for a dashboard that monitors and reports system wide AutoDB Service job activity. Dashboard KPIs are broken down and reported by today, yesterday, and 30-day trend to allow users to easily identify trends and outliers over time. The intent of this reporting is to allow a system administrator or DBA to validate that AutoStats tuning is enabled and delivering value.

General API Usage

Dashboard APIs are in the form of SQL stored procedures residing within owning database TDStats whose output is typically in the form of relational dynamic result sets. Most APIs offer input parameters that limit the scope of their operation to a particular set of objects or queries. APIs typically have only a single JSON input parameter which supports an extensible set of one or more name-value pairs.

REPLACE PROCEDURE TDStats.<APIName> (
   IN jIn JSON(2000) CHARACTER SET UNICODE)
   DYNAMIC RESULT SETS 1 
CALL TDStats.<APIName> ( '{"Param1_Name":"Param1_Value", "Param2_Name":"Param2_Value",...}');