SOAP API method PdfDocumentSnapshot_faxStatistics
Description
The parameter can hold the following options: begintime -> start time of the mailings. endtime -> end time of the mailings.
Parameters
- Parameter 'id' : int
- Unique identifier (id) of the object PdfDocumentSnapshot. The method only applies to the pdfdocumentsnapshot with this id.
- Parameter 'personalize_profile' : int
- Profile ID for which the object should be personalized
- Parameter 'personalize_subprofile' : int
- Subprofile ID for which the object should be personalized
- Parameter 'personalize_timestamp' : string
- The timestamp for the personalization
- Parameter 'options' : Collection of type 'options'
- Parameter 'login' : Structure of type 'login'
- Optional login data
Return values
- Return value 'faxstatistics' : Structure of type 'faxstatistics'
Structure 'pair'
This structure pair was mentioned above. This structure has the following properties:
- Property 'key' : string
- Property 'value' : string
Structure 'options'
This structure options was mentioned above. This structure has the following properties:
- Property 'pair' : Structure of type 'pair'
Structure 'login'
This structure login was mentioned above. This structure has the following properties:
- Property 'username' : string
- The username of the login attempt
- Property 'account' : string
- The account name of the login attempt
- Property 'password' : string
- The password for the login attempt
Structure 'faxstatistics'
This structure faxstatistics was mentioned above. This structure has the following properties:
- Property 'errorCount' : int
- All the error counted in the faxmailings.
- Property 'succesCount' : int
- All the succesfull counted in the faxmailings.
- Property 'unknownCount' : int
- All the unknown mailings counted in the faxmailings.
- Property 'destinationcount' : int
- The number of destinations of the mailing.
- Property 'firsttimestamp' : timestamp
- The first timestamp within these statistics.
- Property 'lasttimestamp' : timestamp
- The last timestamp within these statistics