usage.rate_limit

The statistics consist of the API rate limit in calls per second as well as the number of calls in the latest one second period if a session id is passed to the command.

Passing in an orgId requires Super Ops rights.

Usage can be requested either with no parameters, or one by specifying one of the following:

• A sessionId for a user or thing, or

• An orgId

TR50 Request

                        // No parameters
{
  "cmd": {
    "command": "usage.rate_limit"
  }
}
 
// Query by session Id
{
  "cmd": {
    "command": "usage.rate_limit",
    "params": {
      "sessionId": "56f2db4d486b344870306443"
    }
  }
}
 
// Query by org Id
{
  "cmd": {
    "command": "usage.rate_limit",
    "params": {
      "orgId": "534c36e53100460721000051"
    }
  }
}
      

Request Parameters

TR50 Response

If the command is sent successfully a success message and the statistics are returned. Otherwise, an error and error message will be returned.

                        {
  "1": {
    "success": true,
    "params": {
      "apiRateLimit": 99,
      "commandCounterValue": 1
    }
  }
}
      

Response Parameters