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.

Supported Roles
Available Services
1. Request Summary Data
2. User-specific Request Summary Data
Developer Usage Reports Description
Expansions

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.