SOAP API method Database_emailingStatistics

Back to API references

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 Database. The method only applies to the database with this id.
Parameter 'options' : Collection of type 'options'
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'emailingstatistics' : Structure of type 'emailingstatistics'

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 'emailingstatistics'
This structure emailingstatistics was mentioned above. This structure has the following properties:
Property 'delivered' : int
Any email that is not rejected by a server (delivered)
Property 'clickcount' : int
All the clicks counted in the mailings.
Property 'impressionCount' : int
All the Impressions counted in the mailings.
Property 'errorCount' : int
All the errors counted in the mailings.
Property 'abusecount' : int
The total number of abuses that were registered
Property 'unsubscribecount' : int
The total number of unsubscribes that were registered
Property 'unknownCount' : int
All the unknown types counted in the mailings.
Property 'ctr' : integer
Get the click trough rate of the statistics
Property 'cto' : integer
Get the click to open rate of the statistics
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