SOAP API method EmailingDocument_processedEmailings

Description

The emailings that where processed can be filtered by several things. You can filter the type of the emailings, the kind of emailings, the contenttype of the emailings, how to order the emailings, and if the order is ascending or descending.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object EmailingDocument. The method only applies to the emailingdocument 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
type	string	Type of mail: "individual", "mass", "both",
test	string	Test or normal mailings: "test", "normal", "both"
contenttype	string	Content type: "html", "text", "both"
archived	string	The possible values are "yes", "no", "both"
followups	string	The possible values are "yes", "no", "both"
order	string	The possible values are "id", "timestamp", "individual", "test", "embedded", "contenttype", "personalize", "destinationcount"
asc	boolean	Order in ascending order
search	Collection of type 'search'	Array with search options where the following fields are allowed: The following fields are allowed: - totalmin: integer with minimum amount of sent messages - totalmax: integer with maximum amount of sent messages - impressionsmin: integer with minimum amount of impressions - impressionsmax: integer with minimum amount of impressions - errorsmin: integer with minimum amount of errors - errorsmax: integer with maximum amount of errors - clicksmin: integer with minimum amount of clicks - clicksmax: integer with minimum amount of clicks - fromdate: string date in mysql format to show all mailings from this date - todate: string date in mysql format to showl all mailings to this date - documentname: string show all mailings who sent a document with this name - subject: string subject show all mailings who had this subject - documentnameorsubject: string to show mailings with the value like subject or document name. - database: integer with id of the database the mailing was sent to - view: integer with id of the view the mailing was sent to - collection: integer with id of the collection the mailing was sent to - miniview: integer with id of the miniview the mailing was sent to
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
start	int	Optional parameter that specifies the first element in the collection to be returned. If this parameter is omitted, the first entry in the collection is also the first entry that is returned. Use this parameter is you only want to retrieve a part of the collection.
length	int	Optional parameter that can be used to limit the number of returned elements of this method. If this parameter is omitted, all entries in the collection are returned. If you specify a length, this method will not return more than the specified number of entries.
allproperties	boolean	Optional parameter that specifies if only a limited number of properties of the requested objects are returned or, when this parameter is set to true, whether all properties of the objects are returned.
* required parameters

Return values

Name	Type	Description
start	int	The first element of the collection
length	int	The number of elements that are returned
total	int	The total available elements of the collection
allproperties	int	When this element is available in the return value, the objects in the collection are fully filled, otherwise only a limited number of fields from the objects are filled
processedemailing	Collection of type 'processedemailing'

Structure 'pair'

Name	Type	Description
key	string
value	string

Structure 'search'

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 'processedemailing'

Name	Type	Description
embedded	boolean	Are the images embeded?
contenttype	string	The contenttype of the mailing.
registerclicks	string	Will the clicks be registered?.
registerimpressions	boolean	Will the impressions be registered?.
registererrors	boolean	Will the errors be registered?.
clickcount	int	The total number of clicks.
impressioncount	int	The total number of impressions.
errorcount	int	The total number of errors.
abusecount	int	The total number of abuses that were registered
destinationcount	int	The total number of destinations.
id	int	Get the ID of the mailing.