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 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
Terms of Use

Privileged API Keys Only

Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

Developers: Usage Summary Report

The developer auditing services allow MLS staff to view the activity of client applications built on Spark. Users may only see information related to requests made on their own data in the past 7 days.

 
  1. Supported Roles
  2. Available Services
    1. Request Summary Data
    2. User-specific Request Summary Data
  3. Developer Usage Reports 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 Only accessible by MLS and association users, and by API keys granted explicit permission.

More information about roles may be found here.

 

Available Services

Request Detail data

/<API Version>/developers/audit/summary

HTTP Method Description Conditional Notes
GET Returns all requests in the past 7 days, ordered by most recent request 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
Standard search and paging syntax No _limit has a max of 500.
 
 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
            "Key": "APPLICATION_API_KEY",
            "DataRole": "private",
            "DeveloperName": "FBS Data Systems",
            "ApplicationName": "My Application",
            "ApplicationUri": "http://joe.fbsdata.com",
            "ReplicationAllowed": false,
            "MostRecentRequestTimestamp": "2017-02-27T10:01:06-05:00",
            "AverageDailyRequests": 1200,
            "YesterdayRequests": 1300,
            "ErrorRate": 0.0023,
            "Mls": {
              "Id": "20160223165020414374000000",
              "Name": "Demo MLS"
            }
          }
        ]
    }
}
 
 

User-specific Request Detail data

/<API Version>/developers/audit/summary/users/<User.Id>

HTTP Method Description Conditional Notes
GET Returns all requests in the past 7 days, ordered by most recent request 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 _orderby and _page not permitted. _limit has a max of 500.
 
 

GET Response

See the GET request section for for the summary service.

 

Developer Usage Reports Description

Searchable Fields

This service is filterable by the following attributes for the Developer Detail Report, even though they may not returned in the response for this service: IdentityId, Key, and MlsId.

Attribute Data Type Searchable Sortable Description
Key Character Yes No The API Key used in the request.
DataRole Character No No The data role used during the request.
DeveloperName Character No No The name of development company associated with the key making the request.
ApplicationName Character No No The name of the key, ideally an end-user friendly string that names the application using the key.
ApplicationUri Character No No An end-user friendly URI linking to a website with information about the product the key is for.
ReplicationAllowed Boolean No No If true, the key has been be granted access to Spark's data replication services.
MostRecentRequestTimestamp Timestamp No No The time of the most recent request made by the application.
AverageDailyRequests Integer No Yes The daily requests made for each day in the previous 7 days a request was made.
YesterdayRequests Integer No Yes The number of requests made by the application yesterday.
ErrorRate Decimal No No The rate of errors vs. total requests.
Mls Accounts The account information for the MLS the authorization is on behalf of.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.