Contact_Get_History_Multiple

Contact_Get_History_Multiple( string keyoptional struct optionalParameters)
 

Note: When using one of the API wrappers, you do not need to pass the API key. The wrapper will pass the key for you, your first parameter should be the second parameter in the signature.

Description

Get the history for a set of contacts. All contact history data is returned by default.

Parameters

  string key Your API key - used to authenticate your account
optional struct optionalParameters A struct of optional parameters, see below for valid keys
Format for minDate and maxDate:
- A specified date/time in the format: YYYY-MM-DD HH:MM:SS
- A relative time string including, but not limited to:
* "now"
* "today"
* "tomorrow"
* "first day of January 2010" (example)
* "last day of March 2010" (example)
* "Monday this week" (example)
* "Tuesday next week" (example)

- Values allowed in the historyTypes:
* click
* open
* send
* status
* customFields
* subscription
* bounce

optionalParameters can include:

struct addressIds A struct of email address IDs
struct campaignIds A struct of campaign IDs
string minDate Return contact history created on or after minDate. Format as UTC.
string maxDate Return contact history created on or before maxDate. Format as UTC.
struct historyTypes Limit the type of contact history data returned.
string sortDir Sort direction, valid values: U, D
int offset The number of records to skip (specify a starting point)
int num The maximum number of records to return (must also specify an offset when using the num parameter)

Return

struct Returns a struct of history information
 

Still need help? Contact Us Contact Us