Product Documentation

GetSessionCountTrend

Jul 24, 2013

Gets the data points to represent a trend of concurrent sessions (connected) as a list of DateTime/value pairs for the specified time window. Each point represents the maximum number of concurrent connected sessions over the interval specified. This value is calculated as the sum of the DesktopGroups and the MAX of the sum.

Parameter Name Type Comments
startDate DateTime Start of the time window to be queried for concurrent sessions. Must be UTC.
endDate DateTime End of the time window to be queried for concurrent sessions. Must be UTC.
intervalLength int Interval between data points in minutes for the trend.
sessionSupportFilter string List of comma-delimited machine type ints to limit the query to (Single=1, Multiple=2, Unknown=0). If not specified, default is all.
connectionStateFilter string List of comma-delimited connection state integers to limit the query to (1=Connected, 2=Disconnected). If not specified, both are returned.
desktopGroupFilter string List of comma-delimited Delivery Group Uids to limit the query to. If not specified, returns all Delivery Groups.

Returns

IQueryable list of TrendItem objects - IQueryable<TrendItem> - ordered by Date ascending.

Each TrendItem contains a UTC Date (DateTime) property and a Value property (int) for plotting the trend.

Example

Gets a 24-hour trend with data points every hour for concurrent connected sessions. Each data point represents the maximum number of concurrent sessions (connected only) in the last interval (60 minutes in this case).

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='1'

Gets a 24-hour trend with data points every hour for concurrent disconnected sessions. Each data point represents the maximum number of concurrent sessions (disconnected only) in the last interval (60 minutes in this case).

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='2'

Gets past week's trend with data points every 6 hours for concurrent sessions (connected and disconnected) for both machine types (Desktop OS and Server OS Machines). Each data point represents the maximum number of concurrent sessions in the last interval (6 hours in this case).

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=360