Logo
OpenScaler
API Documentation/Stats

Retrieve VPC public traffic stats history

Get history VPC stats in given time span, or for given range (start -> end); in which case the given timespan will be applied if data is available in given range.

Public here means the traffic going in and out of the VPC, not the internal traffic inside of it (for example between two virtual machines in same VPC). This is the traffic that the user will be billed for.

Notes :

  • sometimes the reply might be delayed for few seconds, this will happen if you request was sent while new stats are being written.
GET
/v1/stats/vpcs/{vpc_id}

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

vpc_idRequiredstring

A unique identifier for a VPC instance. See VPCs section for more details.

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/vpcs/5" \
  -H "Authorization: Bearer <token>"

The response is a JSON object with the following fields:

  • meta: metadata about the stats
  • data: 2D containing stats data where each row is a data point at given instant and each column is a stat category (e.g. tx, rx).

{
  "meta": {
    "step": 60,
    "start": 1672565200,
    "end": 1672565200,
    "rows": 120,
    "columns": 10,
    "legend": [
      "rx",
      "tx"
    ]
  },
  "data": [
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      null,
      null
    ],
    [
      0.7049415575770971,
      0.6392863186500269
    ],
    [
      0.7303810571095024,
      0.17954750793147822
    ],
    [
      0.44679365565810836,
      0.018130894380722573
    ],
    [
      0.235376433423779,
      0.9017556874843077
    ],
    [
      0.5682892587062257,
      0.6438457963990755
    ],
    [
      0.13921111504043304,
      0.5868470677443638
    ],
    [
      0.12592475776064738,
      0.2713036064675072
    ],
    [
      0.26942759840746033,
      0.5506040759930019
    ],
    [
      0.6660331896941745,
      0.4929802417785062
    ],
    [
      0.738536452576965,
      0.31216641512284704
    ],
    [
      0.5987954332789174,
      0.3353681186346391
    ],
    [
      0.780787152285007,
      0.903556453434933
    ],
    [
      0.5318503216448301,
      0.43930514563006606
    ],
    [
      0.453136176911774,
      0.2719328695743377
    ],
    [
      0.2866004540837481,
      0.6710204734205634
    ],
    [
      0.06425008743916583,
      0.6699685039712432
    ],
    [
      0.3005036748185608,
      0.20380269913792626
    ],
    [
      0.8493210881460133,
      0.5583702360134536
    ],
    [
      0.19759948615863998,
      0.6655906966639173
    ],
    [
      0.6438946855117494,
      0.2025254579418092
    ]
  ]
}

Previous

Retrieve VM stats history GET

Next

Retrieve Load Balancer Stats GET