Product Documentation

GetConnectionFailureTrendsByType

Jul 24, 2013

Gets a list of connection failure counts by type, together with a trend for each type, for the specified time period. Each data point in the trend represents the total number of connection failures in the last interval (intervalLength parameter). Provides ability to specify a particular failure type to limit the query or get all failure types.

Parameter Name Type Comments
startDate DateTime Start of the time window to be queried for the connection failure trend. Must be UTC.
endDate DateTime End of the time window to be queried for the connection failure trend. Must be UTC.
intervalLength Int Interval between data points in minutes for the trend.
connectionFailureType Int [ConnectionFailureType] If provided (>0), returns only that connection failure type in the results. Otherwise (null or zero) returns a list of all failure types. This integer corresponds to ConnectionFailureType enum.

Returns

An IQueryable of ConnectionFailureTrend objects that contain the following for each ConnectionFailureType.

If all types are requested, then the sum is also returned with ConnectionFailureType = -1

If $expand=FailureTrend is included in the query, then the trend and TotalFailureCount properties are retrieved for each failure type.

If $expand=DesktopGroupBreakdown is included in the query, that property is also retrieved for each failure type.

Property Name Type Comments
ConnectionFailureType int [ConnectionFailureType] Type of connection failure (from enum ConnectionFailureType).
FailureTrend List<TrendItem> TrendItem contains a UTC Date (DateTime), and a Value (nullable double) to indicate the trend of connection failures over the time period specified for this type of failure.
TotalFailureCount int Total number of failures over the specified time period.
DesktopGroupBreakdown List<DesktopGroupBreakdown> DesktopGroupBreakdown contains a DesktopGroup object (must be included in the expand to be returned) and Count (int) to represent the total number of failures in the specified time window.

Examples

Retrieve both Delivery Group breakdown and the failure trend for all failure types for Nov-14 at 5am (UTC) to Nov 14 at 7am (UTC) with a data point every 30 minutes:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&intervalLength=30&connectionFailureType=0&$expand=FailureTrend,DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Retrieve Delivery Group breakdown only for the failure type 4 (No Capacity Available) for Nov-14 at 5am (UTC) to Nov 14 at 7am (UTC)

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&connectionFailureType=4&$expand=DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Retrieve the failure trend for all failure types from Nov-14 at 12am (UTC) to Nov 14 at 11pm (UTC) with a data point every hour:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T00:00:00'&endDate=datetime'2011-11-14T23:00:00'&intervalLength=60&connectionFailureType=0&$expand=FailureTrend