MiX Telematics REST API

GET /account/rate_limit_status

Requests the rate limit status for the authenticated user account.

Note: This call is not rate-limited.

Parameters

auth

(required)

The authentication token received in response to the call to POST authentication_credentials or GET authentication_token. Applications should pass the authentication token in the custom "X-auth" HTTP header to avoid passing it in in the query string.

callback

(optional)

Only available for JSON format. If supplied, the response will use JSONP format with a callback of the given name.

Request Content Type

N/A

Response

Returns the AccountRateLimitStatus resource in the requested format.

Response Content Type

application/json, application/javascript (JSONP), application/xml or text/csv as requested

Give It A Try...

Enter appropriate parameter values then click on the link which appears to try the API call...

Note: You must have JavaScript support enabled in your browser to use this feature.

auth

(required)

callback

(optional)

Response format

 

Request Examples

GET /account/rate_limit_status?auth=e722fa0c702f42b68e2fdb771a80caed
GET /account/rate_limit_status.json?auth=e722fa0c702f42b68e2fdb771a80caed
GET /account/rate_limit_status.xml?auth=e722fa0c702f42b68e2fdb771a80caed
GET /account/rate_limit_status.csv?auth=e722fa0c702f42b68e2fdb771a80caed

Response Examples

JSON body:

{
  "MaxHitsPerHour": 240,
  "HitsRemaining": 238,
  "Resets": "2024-10-02T13:20:51.8566383Z"
}

XML body:

<?xml version="1.0"?>
<AccountRateLimitStatusResource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MaxHitsPerHour>240</MaxHitsPerHour>
  <HitsRemaining>238</HitsRemaining>
  <Resets>2024-10-02T13:20:51.8566383Z</Resets>
</AccountRateLimitStatusResource>

CSV body:

MaxHitsPerHour,HitsRemaining,Resets
240,238,2024-10-02T13:20:51.8566383Z