SOAP API method ProcessedEmailingFinalGroup_clicks

Description

All the clicks of the mailing.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object ProcessedEmailingFinalGroup. The method only applies to the processedemailingfinalgroup with this id.
urls	Collection of type 'urls'	Urls to look for, this can be the ID's of snapshotlinks or the snapshotlink objects
distinct	boolean	Only return distinct clicks, multiple clicks from the same profile are ignored
mergecurrent	boolean	Merge click with profile data of profiles that still exist. Clicks from removed profiles are not returned
order	string	The field by which the result should be ordered
asc	boolean	Order in ascending or descending order
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
emailingclick	Collection of type 'emailingclick'

Structure 'urls'

Name	Type	Description
	string

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

Name	Type	Description
id	int	The ID of the click.