Viewpoint Sessions REST APIs | Supported Operations | Teradata Viewpoint - Supported Operations - Teradata Viewpoint - Teradata Data Lab

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide - 25.05
Deployment
VantageCloud
VantageCore
Edition
VMware
Enterprise
IntelliFlex
Lake
Product
Teradata Data Lab
Teradata Viewpoint
Release Number
25.05
Published
May 2025
ft:locale
en-US
ft:lastEdition
2025-06-05
dita:mapPath
mxj1746771298572.ditamap
dita:ditavalPath
oqt1542232706976.ditaval
dita:id
prd1525780132746
Product Category
Analytical Ecosystem
HTTP Method URL Parameters and Path Variables Description Response
GET /api/public/systems/{system_id}/sessions
Path Variable
  • system_id: The id of the system
Optional Parameters
  • time_stamp: Timestamp at which sessions are requested. Default is current server time.
  • state: The state in which sessions are. Default is All.
  • per_page: Number of sessions to return per page. Any number less than 1 will be interpreted as ALL. Default is 100. Maximum is 500.
  • page: The page number to return. Default is 1.
  • showSql: Set to TRUE to display the SQL text of each session.
 Returns a list of all the sessions on a given Teradata system A list of sessions
GET /api/public/systems/{system_id}/sessions/{sessionNo}
Required Parameters
  • system_id: The id of the system
  • sessionNo: The number of the session
Optional Parameter
  • time_stamp: Timestamp at which session details are requested. Default value is current server time.
  • show_sql: Set to TRUE to display the SQL text of the session.
 Returns information for the specified session number Details of a session