GetNotificationsUsageResponseType ( AbstractResponseType )

Returns an array of notifications sent to a given application identified by the appID (comes in the credentials). The result can be used by third-party developers troubleshoot issues with notifications.

Zero, one or many notifications can be returned in the array. The set of notifications returned is limited to those that were sent between the StartTime and EndTime specified in the request.

If StartTime or EndTime filters were not found in the request, then the response will contain the data for only one day (Now-1day). By default, maximum duration is limited to 3 days (Now-3days). These min (1day) and max(3days) applies to Notifications, MarkDownMarkUpHistory and NotificationStatistics.

Notifications are sent only if the ItemID is included in the request. If there is no ItemID, then only Statistics and MarkDownMarkUpHistory information is included.

Call that uses GetNotificationsUsageResponseType:

GetNotificationsUsage

Fields

EndTime ( dateTime )

MarkUpMarkDownHistory ( MarkUpMarkDownHistoryType )

NotificationDetailsArray ( NotificationDetailsArrayType )

NotificationStatistics ( NotificationStatisticsType )

StartTime ( dateTime )

EndTime ( dateTime ) [0..1]

Returns the end date and time for the notification information that is returned by this call.

See the Field Index to learn which calls use EndTime.

MarkUpMarkDownHistory ( MarkUpMarkDownHistoryType ) [0..1]

List of objects representing MarkUp or MarkDown history for a given appID and for given StartTime and EndTime. This node will always be returned.

See the Field Index to learn which calls use MarkUpMarkDownHistory.

NotificationDetailsArray ( NotificationDetailsArrayType ) [0..1]

List of notification objects representing the notifications sent to an application for the given time period.

See the Field Index to learn which calls use NotificationDetailsArray.

NotificationStatistics ( NotificationStatisticsType ) [0..1]

Summary information about number of notifications that were successfully delivered, queued, failed, connection attempts made, connection timeouts, http errors for the given appID and given time period. By default, statistics for only one day (Now-1day) is included. Maximum time duration allowed is 3 days (Now-3days).

See the Field Index to learn which calls use NotificationStatistics.

StartTime ( dateTime ) [0..1]

Returns the start date and time for the notification information that is returned by this call.

See the Field Index to learn which calls use StartTime.