{"id":3623,"date":"2023-08-30T06:30:19","date_gmt":"2023-08-30T05:30:19","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3623"},"modified":"2024-10-22T10:29:37","modified_gmt":"2024-10-22T09:29:37","slug":"get-subscriber-information","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/subscribers\/get-subscriber-information\/","title":{"rendered":"Get subscriber information"},"content":{"rendered":"\n

Get varied description of single Subscriber. There are 5 options of getting information:<\/p>\n\n\n\n

Short information<\/th>Short information w\/suppression lists<\/th>Full information<\/th><\/tr><\/thead>
Subscriber’s state on particular lists
Is this subscriber on Global or Local Blacklist
Geographic information<\/td>		Subscriber’s state on particular lists
Is this subscriber on Global or Local Blacklist 
Suppression lists subscriber belongs to
Geographic information<\/td>		Subscriber’s state on particular lists
Is this subscriber on Global or Local Blacklist
Suppression lists subscriber belongs to
Subscriber\u2019s data:
First name
Last name
IP
Subscriber ID
Email
Phone
Custom Subscriber ID
Custom Channel ID
Vendor
All Properties
Geographic information<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Events history<\/th>Subscriptions history<\/th><\/tr><\/thead>
 Information about all events associated with subscriber, such as sending a message, clicks, opens etc
This is the same information as can be seen in the panel’s Subscriber details<\/td>		 Information about all subscription and unsubscription events associated with a subscriber
This is the same information as can be seen in the panel’s Subscriber details<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Request data format#<\/a><\/h3>\n\n\n\n
Parameter<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>staring<\/td>Your API key, used for authentication. Required.<\/td><\/tr>
id<\/td>integer<\/td>Subscriber’s ID.Optional*<\/td><\/tr>
email<\/td>string<\/td>Subscriber\u2019s email. Optional.*<\/td><\/tr>
md5<\/td>string<\/td>Subscriber\u2019s email in Md5 format. Optional.*<\/td><\/tr>
sha256<\/td>string<\/td>Subscriber\u2019s email in Sha256 format. Optional.*<\/td><\/tr>
phone<\/td>string<\/td>Subscriber’s phone number.*<\/td><\/tr>
customSubscriberId<\/td>string<\/td>Subscriber’s custom ID. Optional.*<\/td><\/tr>
customChannelId<\/td>string<\/td>Subscriber’s Custom Channel ID. Optional. ***<\/td><\/tr>
option<\/td>string**<\/td>Required. There are 4 options of getting information:
Short – Basic information 
Long – Basic information plus suppression list info 
Full – Full information with property values
EventsHistory – History of events associated with subscriber
SubscriptionsHistory – History of subscriptions\/unsubscriptions of a subscriber<\/td><\/tr>
bounceDetails<\/td>bool<\/td>Parameter used only if the option=EventHistory is selected. In the case of true will be returned bounce diagnostic code.<\/td><\/tr>
geoDetails<\/td>
bool<\/td>		Subscriber’s geographic details.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

* At least one of the following must be specified: Id, Md5, Sha256, Email, Phone or CustomSubscriberId. System will firstly look for Id, then Email, Md5, Sha256, Phone and CustomSubscriberId. If more than one is specified system will use the first element with any value and ignore the others.
** For compatibility reasons, you may use integers (1, 2, 3, 4) instead of string. But this method of selecting type of returned information should be considered deprecated<\/strong>.
*** only when custom channel is activated<\/p>\n\n\n\n

<\/a><\/a>Response<\/h3>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
BlackListEmail<\/td>boolean<\/td>If set to \u201ctrue\u201d (note the lowercase!), this parameter means that current email is on some blacklist (local or global). \u201cfalse\u201d means that current email isn\u2019t on any blacklist. Omitted if subscriber doesn’t have an email address.<\/td><\/tr>
BlackListPhone<\/td>boolean<\/td>If set to \u201ctrue\u201d (note the lowercase!), this parameter means that current phone is on some blacklist (local or global). \u201cfalse\u201d means that current phone isn\u2019t on any blacklist. Omitted if subscriber doesn’t have a phone number.<\/td><\/tr>
StateOnLists<\/td>array[complex]<\/td>Array of StateOnList elements.<\/td><\/tr>
City<\/td>
string<\/td>		Subscriber’s city<\/td><\/tr>
Country<\/td>
string<\/td>		Subscriber’s country<\/td><\/tr>
State<\/td>
string<\/td>		Subscriber’s state<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

StateOnList element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Email<\/td>string<\/td>Subscriber’s email address.<\/td><\/tr>
Phone<\/td>integer<\/td>Subscriber’s phone number.<\/td><\/tr>
ListId<\/td>integer <\/td>ID of subscribed list.<\/td><\/tr>
Name<\/td>string<\/td>Name of subscribed list.<\/td><\/tr>
Status<\/td>string<\/td>Subscriber state on particular list.<\/td><\/tr>
SubscribedOn<\/td>datetime<\/td>Date of subscription.<\/td><\/tr>
UnsubscriptionDate<\/td>datetime<\/td>Date of unsubscription. Returned only for unsubscribed status.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response for “Long” information<\/strong><\/h3>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
BlackListEmail<\/td>boolean<\/td>If set to \u201ctrue\u201d (note the lowercase!), this parameter means that current email is on some blacklist (local or global). \u201cfalse\u201d means that current email isn\u2019t on any blacklist. Omitted if subscriber doesn’t have an email address.<\/td><\/tr>
BlackListPhone<\/td>boolean<\/td>If set to \u201ctrue\u201d (note the lowercase!), this parameter means that current phone is on some blacklist (local or global). \u201cfalse\u201d means that current phone isn\u2019t on any blacklist. Omitted if subscriber doesn’t have a phone number.<\/td><\/tr>
StateOnLists<\/td>array[complex]<\/td>Array of StateOnList elements.<\/td><\/tr>
SuppressionLists<\/td>array[complex]<\/td>Array of SuppressionList elements.<\/td><\/tr>
City<\/td>string<\/td>Subscriber’s city<\/td><\/tr>
Country<\/td>string<\/td>Subscriber’s country<\/td><\/tr>
State<\/td>string<\/td>Subscriber’s state<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

StateOnList element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Email<\/td>string<\/td>Subscriber’s email address.<\/td><\/tr>
Phone<\/td>integer<\/td>Subscriber’s phone number.<\/td><\/tr>
ListId<\/td>integer<\/td>ID of subscribed list.<\/td><\/tr>
Name<\/td>string<\/td>Name of subscribed list.<\/td><\/tr>
Status<\/td>string<\/td>Subscriber state on particular list.<\/td><\/tr>
SubscribedOn<\/td>datetime<\/td>Date of subscription.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

SuppressionList element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>integer<\/td>ID of current suppression list.<\/td><\/tr>
Name<\/td>string<\/td>Name of current suppression list.<\/td><\/tr>
Type<\/td>string<\/td>Type of current suppression list. Possible types are:
Email
Phone<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response for “<\/strong>Full<\/strong>” information<\/strong><\/h3>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
BlackListEmail<\/td>boolean<\/td>If set to \u201ctrue\u201d (note the lowercase!), this parameter means that current email is on some blacklist (local or global). \u201cfalse\u201d means that current email isn\u2019t on any blacklist. Omitted if subscriber doesn’t have an email address.<\/td><\/tr>
BlackListPhone<\/td>boolean<\/td>If set to \u201ctrue\u201d (note the lowercase!), this parameter means that current phone is on some blacklist (local or global). \u201cfalse\u201d means that current phone isn\u2019t on any blacklist. Omitted if subscriber doesn’t have a phone number.<\/td><\/tr>
StateOnLists<\/td>array[complex]<\/td>Array of StateOnList elements.<\/td><\/tr>
SuppressionLists<\/td>array[complex]<\/td>Array of SuppressionList elements.<\/td><\/tr>
Firstname<\/td>string<\/td>First name of current subscriber.<\/td><\/tr>
Lastname<\/td>string<\/td>Last name of current subscriber.<\/td><\/tr>
Ip<\/td>string<\/td>IP of current subscriber. Optional.<\/td><\/tr>
Id<\/td>integer<\/td>ID of current subscriber.<\/td><\/tr>
CustomChannelId<\/td>string<\/td>Subscriber’s custom channel ID.<\/td><\/tr>
Email<\/td>string<\/td>Subscriber’s email address.<\/td><\/tr>
Phone<\/td>string<\/td>Subscriber’s phone number.<\/td><\/tr>
CustomSubscriberId<\/td>string<\/td>Subscriber’s custom ID.<\/td><\/tr>
Vendor<\/td>string<\/td>Vendor code of current subscriber. Optional.<\/td><\/tr>
Properties<\/td>array[complex]<\/td>Array of subscriber\u2019s properties. Optional.<\/td><\/tr>
City<\/td>string<\/td>Subscriber’s city<\/td><\/tr>
Country<\/td>string<\/td>Subscriber’s country<\/td><\/tr>
State<\/td>string<\/td>Subscriber’s state<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

StateOnList element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Email<\/td>string<\/td>Subscriber’s email address.<\/td><\/tr>
Phone<\/td>integer<\/td>Subscriber’s phone number.<\/td><\/tr>
ListId<\/td>integer<\/td>ID of subscribed list.<\/td><\/tr>
Name<\/td>string<\/td>Name of subscribed list.<\/td><\/tr>
Status<\/td>string<\/td>Subscriber state on particular list.<\/td><\/tr>
SubscribedOn<\/td>datetime<\/td>Date of subscription.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

SuppressionList element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>integer<\/td>ID of current suppression list.<\/td><\/tr>
Name<\/td>string<\/td>Name of current suppression list.<\/td><\/tr>
Type<\/td>string<\/td>Type of current suppression list. Possible types are:
Email
Phone<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Properties element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>integer<\/td>ID of current property.<\/td><\/tr>
Source<\/td>string<\/td>Information about the source of property value. See below for all possible property sources.<\/td><\/tr>
DateTimeValue<\/td>datetime<\/td>Value. Only for date and datetime property.<\/td><\/tr>
IntValue<\/td>integer<\/td>Value. Only for integer properties.<\/td><\/tr>
StringValue<\/td>string<\/td>Value. Only for string properties.<\/td><\/tr>
DecimalValue <\/td>decimal <\/td>Value. Only for money properties. <\/td><\/tr>
Type<\/td>string<\/td>Property type. See below for all possible property types.<\/td><\/tr>
FriendlyName<\/td>string<\/td>Friendly property name.<\/td><\/tr>
Description <\/td>string <\/td>Description of current property.  <\/td><\/tr>
Name<\/td>string<\/td>Name of current property.<\/td><\/tr>
DefaultStringValue<\/td>string<\/td>Default property value. Only for string properties.<\/td><\/tr>
DefaultIntValue<\/td>integer<\/td>Default property value. Only for integer properties.<\/td><\/tr>
DefaultDateTimeValue<\/td>datetime<\/td>Default property value. Only for data and datetime properties.<\/td><\/tr>
DefaultDecimalValue <\/td>decimal <\/td>Default property value. Only for money properties. <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Property sources:<\/p>\n\n\n\n

Name<\/th>Description<\/th><\/tr><\/thead>
Web<\/td>Property was added\/modified using a subscription webform.<\/td><\/tr>
Panel<\/td>Property was added\/modified manually by user in ExpertSender application.<\/td><\/tr>
Import<\/td>Property was added\/modified during an import.<\/td><\/tr>
Api<\/td>Property was added\/modified using ExpertSender REST API.<\/td><\/tr>
PrefCenter<\/td>Subscriber added\/modified the property on Preference Center page.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Property types:<\/p>\n\n\n\n

Name<\/th>Description<\/th><\/tr><\/thead>
Text<\/td>Text (string) property.<\/td><\/tr>
Number<\/td>Whole number, e.g. ‘0’ or ‘123’.<\/td><\/tr>
Money<\/td>A number with two decimal places, e.g. ‘10.99’.<\/td><\/tr>
Url<\/td>Url.<\/td><\/tr>
Date<\/td>Date, e.g. ‘2011-01-01’.<\/td><\/tr>
Datetime<\/td>Date and time information, e.g. ‘2011-01-01 12:00:00’.<\/td><\/tr>
SingleSelect<\/td>An enumeration of predefined values with one selected value possible, e.g. ‘option 1’.<\/td><\/tr>
Boolean<\/td>True\/false.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response for “EventsHistory” information<\/strong><\/h3>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Events<\/td>array[complex]<\/td>Array of Event elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Event element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
StartDate<\/td>datetime <\/td>Event start date.<\/td><\/tr>
EndDate<\/td>datetime<\/td>Event end date.<\/td><\/tr>
Channel<\/td>string<\/td> Channel involved in an event. Possible values:
EmailSmsMms<\/td><\/tr>
MessageType<\/td>string<\/td>Type of message involved in an event. Newsletter, Autoresponder, Trigger, Transactional etc.<\/td><\/tr>
EventType<\/td>string<\/td>Type of event. Send, Open, Click, Bounce, Complaint, Confirm, Unsubscribe.<\/td><\/tr>
EventCount<\/td>integer<\/td>Number of event occurrences between StartDate and EndDate.<\/td><\/tr>
MessageId<\/td>integer<\/td>ID of message involved in an event.<\/td><\/tr>
MessageSubject<\/td>string<\/td>Subject of message involved in an event.<\/td><\/tr>
BounceDiagnosticCode<\/td>string<\/td>Contents of the diagnostic code.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response for “<\/strong>SubscriptionsHistory<\/strong>” information<\/strong><\/h3>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
SubscriptionsHistory<\/td>array[complex]<\/td>Array of SubscriptionEvent elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

SubscriptionEvent element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
StartDate<\/td>datetime<\/td>Event start date.<\/td><\/tr>
EndDate<\/td>datetime<\/td>Event end date.<\/td><\/tr>
Channel<\/td>string<\/td>Channel involved in an event. Present only if unit uses any channels besides email. Possible values:
Email
SmsMms<\/td><\/tr>
EventType<\/td>string<\/td>Type of event. Possible values:
Subscribed
Unsubscribed<\/td><\/tr>
List<\/td>string<\/td>Details of a list that the event concerns, in form of “[list id] list name”<\/td><\/tr>
EventSource<\/td>string<\/td>Source that caused the event<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples<\/strong><\/h3>\n\n\n\n

Getting subscriber’s information:<\/strong><\/p>\n\n\n\n

Request:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/Subscribers?apiKey=test_api_key1&email=john%40yahoo.com&option=Full HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nContent-Encoding: gzip<\/span><\/span>\nVary: Accept-Encoding<\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=soo4fqb5y5cjbr3wimnyelb3; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 1.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Mon, 25 Apr 2016 16:07:21 GMT <\/span><\/span>\nContent-Length: 421 <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n   <\/span><<\/span>BlackListEmail<\/span>><\/span>false<\/span><\/<\/span>BlackListEmail<\/span>><\/span><\/span>\n   <\/span><<\/span>BlackListPhone<\/span>><\/span>false<\/span><\/<\/span>BlackListPhone<\/span>><\/span><\/span>\n   <\/span><<\/span>StateOnLists<\/span>><\/span><\/span>\n    <\/span><<\/span>StateOnList<\/span>><\/span><\/span>\n     <\/span><<\/span>Email<\/span>><\/span>john@yahoo.com<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n     <\/span><<\/span>ListId<\/span>><\/span>123<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>Testowa Lista<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><<\/span>Status<\/span>><\/span>Unsubscribed<\/span><\/<\/span>Status<\/span>><\/span><\/span>\n     <\/span><<\/span>SubscribedOn<\/span>><\/span>2014-12-29T15:30:09<\/span><\/<\/span>SubscribedOn<\/span>><\/span><\/span>\n    <\/span><\/<\/span>StateOnList<\/span>><\/span><\/span>\n    <\/span><<\/span>StateOnList<\/span>><\/span><\/span>\n     <\/span><<\/span>Email<\/span>><\/span>john@yahoo.com<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n     <\/span><<\/span>ListId<\/span>><\/span>456<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>Testowa Seed Lista 1 (3)<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><<\/span>Status<\/span>><\/span>Active<\/span><\/<\/span>Status<\/span>><\/span><\/span>\n     <\/span><<\/span>SubscribedOn<\/span>><\/span>2014-11-12T12:30:41<\/span><\/<\/span>SubscribedOn<\/span>><\/span><\/span>\n    <\/span><\/<\/span>StateOnList<\/span>><\/span><\/span>\n    <\/span><<\/span>StateOnList<\/span>><\/span><\/span>\n     <\/span><<\/span>Phone<\/span>><\/span>48789456123<\/span><\/<\/span>Phone<\/span>><\/span><\/span>\n     <\/span><<\/span>ListId<\/span>><\/span>789<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>Testowa Lista 2<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><<\/span>Status<\/span>><\/span>Active<\/span><\/<\/span>Status<\/span>><\/span><\/span>\n     <\/span><<\/span>SubscribedOn<\/span>><\/span>2015-01-11T11:00:02<\/span><\/<\/span>SubscribedOn<\/span>><\/span><\/span>\n    <\/span><\/<\/span>StateOnList<\/span>><\/span><\/span>\n   <\/span><\/<\/span>StateOnLists<\/span>><\/span><\/span>\n   <\/span><<\/span>SuppressionLists<\/span>><\/span><\/span>\n    <\/span><<\/span>SuppressionList<\/span>><\/span><\/span>\n     <\/span><<\/span>Id<\/span>><\/span>1<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>testowa lista suppression nr 1<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><<\/span>Type<\/span>><\/span>Phone<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n    <\/span><\/<\/span>SuppressionList<\/span>><\/span><\/span>\n    <\/span><<\/span>SuppressionList<\/span>><\/span><\/span>\n     <\/span><<\/span>Id<\/span>><\/span>2<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>testowa lista suppression nr 2<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n    <\/span><\/<\/span>SuppressionList<\/span>><\/span><\/span>\n   <\/span><\/<\/span>SuppressionLists<\/span>><\/span><\/span>\n   <\/span><<\/span>Id<\/span>><\/span>3045574<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n   <\/span><<\/span>Email<\/span>><\/span>john@yahoo.com<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n   <\/span><<\/span>Phone<\/span>><\/span>48789456123<\/span><\/<\/span>Phone<\/span>><\/span><\/span>\n   <\/span><<\/span>CustomSubscriberId<\/span>><\/span>522145698<\/span><\/<\/span>CustomSubscriberId<\/span>><\/span><\/span>\n   <\/span><<\/span>Firstname<\/span>><\/span>John<\/span><\/<\/span>Firstname<\/span>><\/span><\/span>\n   <\/span><<\/span>Lastname<\/span>><\/span>Doe<\/span><\/<\/span>Lastname<\/span>><\/span><\/span>\n   <\/span><<\/span>Vendor<\/span>><\/span>RIVER2<\/span><\/<\/span>Vendor<\/span>><\/span><\/span>\n   <\/span><<\/span>Ip<\/span>><\/span>90.2.214.146<\/span><\/<\/span>Ip<\/span>><\/span><\/span>\n   <\/span><<\/span>Properties<\/span>><\/span><\/span>\n    <\/span><<\/span>Property<\/span>><\/span><\/span>\n     <\/span><<\/span>Id<\/span>><\/span>1<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n     <\/span><<\/span>Source<\/span>><\/span>NotSet<\/span><\/<\/span>Source<\/span>><\/span><\/span>\n     <\/span><<\/span>DateTimeValue<\/span> <\/span>xsi<\/span>:<\/span>type<\/span>=<\/span>"<\/span>xsd:dateTime<\/span>"<\/span>><\/span>2016-07-19T00:00:00<\/span><\/<\/span>DateTimeValue<\/span>><\/span><\/span>\n     <\/span><<\/span>Type<\/span>><\/span>Datetime<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n     <\/span><<\/span>FriendlyName<\/span>><\/span>Date added<\/span><\/<\/span>FriendlyName<\/span>><\/span><\/span>\n     <\/span><<\/span>Description<\/span>\/><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>dateadded<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Property<\/span>><\/span><\/span>\n    <\/span><<\/span>Property<\/span>><\/span><\/span>\n     <\/span><<\/span>Id<\/span>><\/span>5<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n     <\/span><<\/span>Source<\/span>><\/span>NotSet<\/span><\/<\/span>Source<\/span>><\/span><\/span>\n     <\/span><<\/span>StringValue<\/span> <\/span>xsi<\/span>:<\/span>type<\/span>=<\/span>"<\/span>xsd:string<\/span>"<\/span>><\/span>Mr<\/span><\/<\/span>StringValue<\/span>><\/span><\/span>\n     <\/span><<\/span>Type<\/span>><\/span>Text<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n     <\/span><<\/span>FriendlyName<\/span>><\/span>Title<\/span><\/<\/span>FriendlyName<\/span>><\/span><\/span>\n     <\/span><<\/span>Description<\/span>\/><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>title<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Property<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Properties<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Getting subscriber’s events history:<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/Subscribers?apiKey=test_api_key1&email=john%40yahoo.com&option=EventsHistory HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nConnection: Keep-Alive<\/span><\/span>\nUser-Agent: Apache-HttpClient\/4.1.1 (java 1.5)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 5.2<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=2baf0f58-63a5-44bc-9673-988be8061978; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Tue, 27 Jan 2017 13:37:40 GMT<\/span><\/span>\nContent-Length: 1259<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>Events<\/span>><\/span><\/span>\n      <\/span><<\/span>Event<\/span>><\/span><\/span>\n        <\/span><<\/span>StartDate<\/span>><\/span>2015-01-25T10:00:00<\/span><\/<\/span>StartDate<\/span>><\/span><\/span>\n        <\/span><<\/span>EndDate<\/span>><\/span>2015-01-25T11:00:00<\/span><\/<\/span>EndDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Channel<\/span>><\/span>Email<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageType<\/span>><\/span>Newsletter<\/span><\/<\/span>MessageType<\/span>><\/span><\/span>\n        <\/span><<\/span>EventType<\/span>><\/span>Click<\/span><\/<\/span>EventType<\/span>><\/span><\/span>\n        <\/span><<\/span>EventCount<\/span>><\/span>1<\/span><\/<\/span>EventCount<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageId<\/span>><\/span>120540<\/span><\/<\/span>MessageId<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageSubject<\/span>><\/span>test of links<\/span><\/<\/span>MessageSubject<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Event<\/span>><\/span><\/span>\n      <\/span><<\/span>Event<\/span>><\/span><\/span>\n        <\/span><<\/span>StartDate<\/span>><\/span>2015-01-25T10:00:00<\/span><\/<\/span>StartDate<\/span>><\/span><\/span>\n        <\/span><<\/span>EndDate<\/span>><\/span>2015-01-25T11:00:00<\/span><\/<\/span>EndDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Channel<\/span>><\/span>SmsMms<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageType<\/span>><\/span>Newsletter<\/span><\/<\/span>MessageType<\/span>><\/span><\/span>\n        <\/span><<\/span>EventType<\/span>><\/span>Send<\/span><\/<\/span>EventType<\/span>><\/span><\/span>\n        <\/span><<\/span>EventCount<\/span>><\/span>1<\/span><\/<\/span>EventCount<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageId<\/span>><\/span>473821<\/span><\/<\/span>MessageId<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageSubject<\/span>><\/span>test competition announcement<\/span><\/<\/span>MessageSubject<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Event<\/span>><\/span><\/span>\n      <\/span><<\/span>Event<\/span>><\/span><\/span>\n        <\/span><<\/span>StartDate<\/span>><\/span>2015-01-25T08:00:00<\/span><\/<\/span>StartDate<\/span>><\/span><\/span>\n        <\/span><<\/span>EndDate<\/span>><\/span>2015-01-25T09:00:00<\/span><\/<\/span>EndDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Channel<\/span>><\/span>Email<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageType<\/span>><\/span>Newsletter<\/span><\/<\/span>MessageType<\/span>><\/span><\/span>\n        <\/span><<\/span>EventType<\/span>><\/span>Send<\/span><\/<\/span>EventType<\/span>><\/span><\/span>\n        <\/span><<\/span>EventCount<\/span>><\/span>1<\/span><\/<\/span>EventCount<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageId<\/span>><\/span>120540<\/span><\/<\/span>MessageId<\/span>><\/span><\/span>\n        <\/span><<\/span>MessageSubject<\/span>><\/span>test of links<\/span><\/<\/span>MessageSubject<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Event<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Events<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Getting subscriber’s subscriptions history:<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/Subscribers?apiKey=test_api_key1&email=john%40yahoo.com&option=SubscriptionsHistory HTTP\/1.1 Accept-Encoding: gzip,deflate<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nConnection: Keep-Alive<\/span><\/span>\nUser-Agent: Apache-HttpClient\/4.1.1 (java 1.5)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 5.2<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=2baf0f58-63a5-44bc-9673-988be8061978; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Tue, 27 Jan 2017 13:37:40 GMT<\/span><\/span>\nContent-Length: 734<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>SubscriptionsHistory<\/span>><\/span><\/span>\n      <\/span><<\/span>SubscriptionEvent<\/span>><\/span><\/span>\n        <\/span><<\/span>StartDate<\/span>><\/span>2018-06-27T20:00:00<\/span><\/<\/span>StartDate<\/span>><\/span><\/span>\n        <\/span><<\/span>EndDate<\/span>><\/span>2018-06-27T21:00:00<\/span><\/<\/span>EndDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Channel<\/span>><\/span>Email<\/span><\/<\/span>Channel<\/span>><\/span><\/span>\n        <\/span><<\/span>EventType<\/span>><\/span>Unsubscribed<\/span><\/<\/span>EventType<\/span>><\/span><\/span>\n        <\/span><<\/span>List<\/span>><\/span>[1] Some default list<\/span><\/<\/span>List<\/span>><\/span><\/span>\n        <\/span><<\/span>EventSource<\/span>><\/span>Opt-out link<\/span><\/<\/span>EventSource<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SubscriptionEvent<\/span>><\/span><\/span>\n      <\/span><<\/span>SubscriptionEvent<\/span>><\/span><\/span>\n        <\/span><<\/span>StartDate<\/span>><\/span>2015-01-03T12:00:00<\/span><\/<\/span>StartDate<\/span>><\/span><\/span>\n        <\/span><<\/span>EndDate<\/span>><\/span>2015-01-25T13:00:00<\/span><\/<\/span>EndDate<\/span>><\/span><\/span>\n        <\/span><<\/span>Channel<\/span>><\/span>Email<\/span><\/<\/span>Channel<\/span>><\/span><\/span>\n        <\/span><<\/span>EventType<\/span>><\/span>Subscribed<\/span><\/<\/span>EventType<\/span>><\/span><\/span>\n        <\/span><<\/span>List<\/span>><\/span>[5] Special campaign list<\/span><\/<\/span>List<\/span>><\/span><\/span>\n        <\/span><<\/span>EventSource<\/span>><\/span>Import<\/span><\/<\/span>EventSource<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SubscriptionEvent<\/span>><\/span><\/span>\n    <\/span><\/<\/span>SubscriptionsHistory<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3621,"menu_order":314,"template":"","format":"standard","emp-category":[],"class_list":["post-3623","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3623","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":8,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3623\/revisions"}],"predecessor-version":[{"id":11609,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3623\/revisions\/11609"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3621"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3623"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3623"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}