Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

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

/<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:

 

GET Response

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

Listings for an Activity

/<API Version>/contacts/<Contact.Id>/activity/listings/viewed
/<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.