Get all the information for particular members of a list
Signature
public function listMemberInfo(string
$id,
array
$email_address )
Parameters
$id
—
string
the list id to connect to. Get by calling lists()
$email_address
—
array
an array of up to 50 email addresses to get information for OR the "id"(s) for the member returned from listMembers, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).
Returns
array
array of list members with their info in an array (see Returned Fields for details) int success the number of subscribers successfully found on the list
int errors the number of subscribers who were not found on the list
array data an array of arrays where each one has member info:
string id The unique id for this email address on an account
string email The email address associated with this record
string email_type The type of emails this customer asked to get: html, text, or mobile
array merges An associative array of all the merge tags and the data for those tags for this email address. <em>Note</em>: Interest Groups are returned as comma delimited strings - if a group name contains a comma, it will be escaped with a backslash. ie, "," => "\,". Groupings will be returned with their "id" and "name" as well as a "groups" field formatted just like Interest Groups
string status The subscription status for this email address, either pending, subscribed, unsubscribed, or cleaned
string ip_signup IP Address this address signed up from. This may be blank if single optin is used.
string timestamp_signup The date/time the double optin was initiated. This may be blank if single optin is used.
string ip_opt IP Address this address opted in from.
string timestamp_opt The date/time the optin completed
int member_rating the rating of the subscriber. This will be 1 - 5 as described <a href="http://eepurl.com/f-2P" target="_blank">here</a>
string campaign_id If the user is unsubscribed and they unsubscribed from a specific campaign, that campaign_id will be listed, otherwise this is not returned.
array lists An associative array of the other lists this member belongs to - the key is the list id and the value is their status in that list.
string timestamp The date/time this email address entered it's current status
string info_changed The last time this record was changed. If the record is old enough, this may be blank.
int web_id The Member id used in our web app, allows you to create a link directly to it
bool is_gmonkey Whether the member is a <a href="http://mailchimp.com/features/golden-monkeys/" target="_blank">Golden Monkey</a> or not.
array geo the geographic information if we have it. including:
string latitude the latitude
string longitude the longitude
string gmtoff GMT offset
string dstoff GMT offset during daylight savings (if DST not observered, will be same as gmtoff
string timezone the timezone we've place them in
string cc 2 digit ISO-3166 country code
string region generally state, province, or similar
array clients the client we've tracked the address as using with two keys:
string name the common name of the client
string icon_url a url representing a path to an icon representing this client
array static_segments static segments the member is a part of including:
int id the segment id
string name the name given to the segment
string added the date the member was added