One of our goals in creating the new VerticalResponse is to have a powerful API, and our latest release brings tons of new goodies in that area. We are constantly working to make the VR REST API very intuitive and robust, and believe we’re hitting the mark with these features:

Detailed Stats APIs

In our previous release, we focused on bringing you analytics APIs providing summary level stats. We promised you we’d be back with more stats APIs, and here we are!

Our Email: Summary Stats API provides overall stats on the number of opens, unsubscribes and bounces for a particular email. However with our new detailed stats, we provide details about which specific contacts opened, unsubscribed, bounced and clicked on specific links in an email. The detailed stats APIs are:

Email

Emails: Opens

This API will list all the contacts that opened a particular email. Depending on the type parameter (basic, standard or all), attributes of contacts are returned.

Sample Request

Sample Response

Emails:Unsubscribes

This API will list all the contacts that unsubscribed from a given email. Depending on the type parameter (basic, standard or all), attributes of contacts are returned.

Sample Request

Sample Response

Email:Bounces

This API will list all the contacts that bounced from a given email. Depending on the type parameter (basic, standard or all), attributes of contacts are returned. The contacts returned have been hard bounced only – VR does not return contacts that have a soft bounce status.

There are two types of bounces

Hard Bounce: A permanent delivery issue like a non-existent email address.

Soft Bounce:  A temporary delivery issue like a full mailbox or technical issue.

Sample Request

Sample Response

Contacts

Returning Status attribute in all Contacts GET APIs

Now, every time a contact list API, Search or a Read API is called, the contact’s status will be returned, regardless of the type parameter. This way it’s easy to know whether a contact is mailable, bounced or unsubscribed.

List Active Contacts

Just like the ability to list inactive contacts, you can now also retrieve a list of all active contacts. Active contacts are mailable contacts, i.e. those who will receive an email campaign that you send out using VerticalResponse. Active contacts determine the reach of a particular mailing list.

Sample Request

Sample Response

OAuth

Now when obtaining an access token, you can also receive the user_id associated with the access token. This is the VR user id of the VerticalResponse user who has given your application access to their VR account.

Sample Response

We continue to work on new and exciting updates, and can’t wait to share it with you all soon. Until then, happy coding!

© 2014 – 2015, Contributing Author. All rights reserved.