ReportTrafficStats()


Statistical Traffic Report for a period of time for the Session Network/Mailbox.

Public Function ReportTrafficStats(ByVal SessionID As String, _
                                  
ByVal TargetTime As Date, _
                                   ByVal NumPeriods As Short, _
                                  
ByVal Period As StatisticsPeriod) _
                                  
As DataSet

Parameters

SessionID
String - GUID
The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
TargetTime 
Date 
This indicates the inital or final time for the report based on whether NumPeriods is positive or negative. 
NumPeriods 
Short
The number of reporting periods to include. A positive number are peroids after the TargetTime. A negative number samples periods with the TargetTime as the last period.
Period 
Short - StatisticsPeriod ENUM 
A numeric value representing the sampling interval.

Returns

DataSet 
The fields included are as follows:
Period
Date
The date/time denoting the beginning of the reported period.
ParcelIn
Integer
The number of Parcels received.
ParcelInKC
Integer
The number of Parcel KCs received.
ParcelOut
Integer
The number of Parcels sent.
ParcelOutKC
Integer
The number of Parcel KCs sent.
InterchangeIn
Integer
The number of Interchanges received.
InterchangeInKC
Integer
The number of Interchange KCs received.
InterchangeOut
Integer
The number of Interchanges sent.
InterchangeOutKC
Integer
The number of Interchange KCs sent.

Remarks

When NumPeriods is positive, TargetTime will be rolled back to match the initial time of the selected Period interval. For example, if the Period is Day, then the TargetTime will be set back to 12 midnight or if the period is Week, then the TargetTime will be set to Sunday at 12 midnight. When NumPeriods is a negative value, TargetTime will be rolled forward to the end of the Period.

There is no record for periods without any activity.

Kilocharacters (KCs) are rounded per Parcel/Interchange based on the Network/Mailbox configuration.

Example

Visual Basic
[insert code sample]

EventID: 8003

See Also

ReportTrafficStatsEx()
ReportTrafficStatsPublic()


© 2008-2011, Loren Data Corp.
All rights reserved.
ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.