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: Billing Summary Report
The developer billing services private a usage overview specific to billable requests. This service only accounts for data from the past year.
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 Billing Summary
/<API Version>/developers/identities/<Identity.Id>/billing
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns per-key hit information for the past year, or in the requested timeframe | 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 | _orderby not permitted. |
| Timespan parameters | No | Default range includes the partial billing data for the current month as well as full billing data for the previous three months. |
GET Response
{
"D": {
"Success": true,
"Results": [
{
"SuccessHits": 10000,
"ClientErrorHits": 219,
"ServerErrorHits": 0,
"Key": {
"Id": 5,
"ResourceUri": "/vX/developers/identities/101/keys/5",
"Type": "OAuth2",
"Name": "My Application",
"Key": "...",
"RedirectUri: "https://sparkplatform.com/callback",
"ApplicationUri": "https://sparkplatform.com",
"SingleSession": true,
"Replication": false,
"DataRole": "idx",
"TemplateId": null,
"Enabled": true,
"Comments": null,
"LastActive": "2012-03-07T21:13:11Z",
"Editable": true,
"ModificationTimestamp": "2014-06-27T10:01:06-05:00",
"CreatedTimestamp": "2014-06-27T10:01:06-05:00"
}
}
]
}
}
Request Billing Summary Description
| Attribute | Data Type | Searchable | Description |
|---|---|---|---|
SuccessHits |
Integer | No | The number of successful hits. |
ClientErrorHits |
Integer | No | The number of hits that resulted in a client (4xx) error. |
ServerErrorHits |
Integer | No | The number of hits that resulted in a server (5xx) error. |
RequestDate |
Date | Yes | For searching only. Restricts the hit tallies to requests made in this time frame. This service only considers request data for the past year. |
Key |
Developer keys | Yes | The API Key the requests were made under. Keys can be filtered as _filter="Key Eq 'my_api_key'", where my_api_key is the Key attribute. |
Expansions
None.
API Explorer
The API Explorer does not currently support this service.