Contacts: Activity

This service summarizes various contact activity data points, such as the number of emails sent to and opened by the contact.

  1. Supported Roles
  2. Available Services
    1. Activity Summary
    2. Listings for an Activity
  3. Contact Activity Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW No No
Portal No No
Private Yes No
More information about roles may be found here.

Available Services

Activity Summary

URI: /<API Version>/contacts/<Contact.Id>/activity

HTTP Method Description Conditional Notes
GET Returns a summary of the contact's activity. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

{
  "D": {
    "Success": true,
    "Results": [{
      "ManualEmailsOpened": 8,
      "ManualEmailsSent": 10,
      "SubscriptionEmailsOpened": 80,
      "SubscriptionEmailsSent": 81,
      "ListingsViewed": 80,
      "ListingsShared": 81
    }]
  }
}

Listings for an Activity

URI: /<API Version>/contacts/<Contact.Id>/activity/listings/viewed

URI: /<API Version>/contacts/<Contact.Id>/activity/listings/shared

HTTP Method Description Conditional Notes
GET Returns the listings viewed or shared by the referenced contact No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
Pagination No
Standard selection parameters No
Standard expansion parameters No The expansions for the listings service apply to this resource.

The ContactActivity expansion will show the activity for each listing record.

GET Response

See the GET request section for the listings service.

Activity Description

Attribute Data Type Description
ManualEmailsOpened Integer The number of manual emails opened in flexmls (i.e. a link in the email contents was clicked) by this contact
ManualEmailsSent Integer The number of manual emails sent to this contact
SubscriptionEmailsOpened Integer The number of subscription emails opened in flexmls (i.e. a link in the email contents was clicked) by this contact
SubscriptionEmailsSent Integer The number of subscription emails sent to this contact
ListingsViewed Integer The number of listings viewed in a flexmls web user interface
ListingsShared Integer The number of listings shared by the contact

Expansions

None.

API Explorer

The API Explorer does not currently support this service.