Privileged API Keys Only
Special permission is required to access this service. Please contact or your API key provider to request access to this data.

Developers: Usage Detail 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 Detail Data
  3. Developer Usage Detail Report Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
Public 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 Report

/<API Version>/developers/audit

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

Parameter Required Notes
Standard search and paging syntax No _orderby not permitted

GET Response

    "D": {
        "Success": true,
        "Results": [
            "DataRole": "private",
            "IpAddress": "APPLICATION IP ADDRESS",
            "Key": "APPLICATION_API_KEY",
            "Method": "GET",
            "HttpStatus": "200",
            "MlsId": "20100127075503180752000000",
            "RequestDuration": 56.1,
            "RequestResourceUri": "/v1/listings",
            "RequestTimestamp": "2017-01-27T12:01:06-06:00",
            "ResoApi": false,
            "ResoDictionaryVersion": 1.4,
            "SparkUserAgent": "APPLICATION NAME",
            "UserAgent": "APPLICATION USER AGENT",
            "UserId": "20110112234857732941000000",
            "User": {
              "Id": "20110112234857732941000000",
              "ResourceUri": "/v1/accounts/20110112234857732941000000",
              "UserType": "Member",
              "Name": "Joe Realtor",
              "OfficeId": "20100113238853732842000000",
              "Office": "Joe's Realty",
              "CompanyId": null,
              "Company": null
              "FbsIdxCustomer": false,
              "MlsId": "20100127075503180752000000"

Developer Usage Detail Report Description

Attribute Data Type Searchable Description
DataRole Character No The data role used during the request.
IpAddress Character No The IP Address the request came from.
Key Character Yes The API Key used in the request.
Method Character No The HTTP request method (GET, POST, etc.)
HttpStatus Character No The HTTP request response status.
MlsId Character Yes The Id of the MLS whose data was accessed during the request.
RequestDuration Decimal Yes The time, in milliseconds, the request took to complete.
RequestResourceUri Character Yes The API resource the request accessed. This field is best searched using at least one wildcard, such as RequestResourceUri Eq '/v1/listings*', as the data itself may vary either in how parts of the URI are capitalized, or which request parameters are included.
RequestTimestamp DateTime Yes The time the request began.
ResoApi Boolean Yes If true Spark's RESO Web API Adapter was accessed.
ResoDictionaryVersion Decimal No The RESO dictionary version used when providing data for this request.
SparkUserAgent Character No The X-SparkApi-User-Agent header supplied in the request. See the Spark API Overview page for more details.
UserAgent Character No The User-Agent specified by the API client during the request.
UserId Character Yes The Id of the MLS user whose data was accessed during the request.
IdentityId Character Yes Not present in response payload. This is available for searching only, and allows records to be filtered to any key belonging to the provided developer identity.
User Accounts The account information for the user the authorization is on behalf of.



API Explorer

The API Explorer does not currently support this service.