Retrieve Load Balancer Stats

Get traffic and performance statistics for a load balancer. Use timespan to get recent stats over a rolling window, or provide start/end (Unix timestamps in milliseconds) for a custom range.

Authorization

AuthorizationRequiredBearer <token>

OAuth Authentication

OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.

Use the access_token in the Authorization header for requests:

Authorization: Bearer <token>

Always keep your token secure and do not share it with anyone.

In: header

Path Parameters

lb_idRequiredstring

A unique identifier for a load balancer instance.

Query Parameters

stats_timespaninteger

time range to get stats from (in seconds):

1 hour
1 day
1 week
1 mounth (31 days)
1 year (366 days) if omitted, will send live stats (use this for testing only, not for prodcution)

Value in: 3600 | 86400 | 604800 | 2678400 | 31622400

stats_startinteger

unix timestamp of the first datapoint

stats_endinteger

unix timestamp of the last datapoint

curl -X GET "https://api.alpha.openscaler.net/v1/stats/lbs/42" \
  -H "Authorization: Bearer <token>"

Load balancer stats.

{
  "meta": {
    "step": 60,
    "start": 1672565200,
    "end": 1672565200,
    "rows": 120,
    "columns": 10
  },
  "data": [
    []
  ]
}

Authorization

OAuth Authentication

Path Parameters

Query Parameters

Response

TypeScript