Back to API references

SOAP API method PdfDocument_faxStatistics


The parameter can hold the following options: begintime -> start time of the mailings. endtime -> end time of the mailings.


Name Type Description
id * int Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument with this id.
personalize_profile int Profile ID for which the object should be personalized
personalize_subprofile int Subprofile ID for which the object should be personalized
personalize_timestamp string The timestamp for the personalization
options Collection of type 'options'
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
faxstatistics Structure of type 'faxstatistics'

Structure 'pair'

Name Type Description
key string
value string

Structure 'options'

Name Type Description
pair Structure of type 'pair'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'faxstatistics'

Name Type Description
errorCount int All the error counted in the faxmailings.
succesCount int All the succesfull counted in the faxmailings.
unknownCount int All the unknown mailings counted in the faxmailings.
destinationcount int The number of destinations of the mailing.
firsttimestamp timestamp The first timestamp within these statistics.
lasttimestamp timestamp The last timestamp within these statistics