Skip to main content
GET
/
api
/
system
/
stats
Get system usage info.
curl --request GET \
  --url https://{tenant}/api/system/stats \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "stats": {
    "apis": [
      {
        "avg_active_usage": 13,
        "avg_usage": 15,
        "date": "2023-07-01",
        "license_entitlement": 25,
        "license_entitlement_active": 20,
        "max_active_usage": 18,
        "max_usage": 20,
        "min_active_usage": 8,
        "min_usage": 10
      }
    ],
    "dataplanes": [
      {
        "avg_active_usage": 13,
        "avg_usage": 15,
        "date": "2023-07-01",
        "license_entitlement": 25,
        "license_entitlement_active": 20,
        "max_active_usage": 18,
        "max_usage": 20,
        "min_active_usage": 8,
        "min_usage": 10
      }
    ],
    "dataplanes_gateways": [
      {
        "avg_active_usage": 13,
        "avg_usage": 15,
        "date": "2023-07-01",
        "license_entitlement": 25,
        "license_entitlement_active": 20,
        "max_active_usage": 18,
        "max_usage": 20,
        "min_active_usage": 8,
        "min_usage": 10
      }
    ]
  },
  "status": "Success"
}

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

​
start_day
string<date>

start date

​
end_day
string<date>

end date

​
resolution
enum<string>

Resolve daily.

Available options:
day
​
entity
enum<string>
default:apis

The entity for which stats should be retrieved.

Available options:
apis,
dataplanes,
dataplanes.gateways

Response

System statistics details.

​
message
string
​
stats
object
​
status
string
Example:

"Success"