logo AWS Technology Partner

API: Metrics

API Endpoint
https://www.redline13.com/Api/Metrics

Retrieve metrics for a given test.
The results will be an array as described, where each endpoint will have a data field with the results in the requested format.

hash
Unique HashID for this endpoint .
label
Full label stored for endpoint.
data
The data object returned with results in format requested, see below for details on format.

API Parameters

Parameter Type Required Details
loadTestId GET Yes

ID of load test.

filter GET Either filter or hash must be supplied

Name of the label or URL, can be partial. No wildcards.

hash GET Either filter or hash must be supplied

HashID of the URL to find, returns only single item in array.

format GET No

csv, xy, default - Format for results.

Formats

Format: CSV

An array in the data field, first row is the headers. Each timestamp can include a count of metrics, the average is the average within that timestamp

  "data": [
    [
      "Timestamp",
      "avgLoadTime",
      "count",
      "downloadSize",
      "errAvgLoadTime",
      "errCount",
      "errDownloadSize"
    ],
    [
      "0",
      "0.858901",
      "10",
      "53.53515625",
      "0",
      "0",
      "0"
    ],
    [
...

The returned fields are:
Timestamp - UNIX timestamp of requests (you should ignore timestamp zero if you see it).
avgLoadTime - This is the average response time in seconds for this endpoint during this time period.
count - Number of requests in this time period.
downloadSize - The size in bytes of the response.
err* - These are equivalent to the above, but for requests that resulted in an error.


Format: XY

An object response, typically used for graphing packages such as Google Charts.
The response includes summary results.
Labels for the known data points.
X,Y Section for each data point (pageRespTimePerSec,pageReqPerSec,pageKbPerSec,pageErrRespTime,pageErrCount,pageErrKb)

  "data": {
    "overview": {
      "avgLoadTime": "0.858901",
      "count": "10",
      "downloadSize": "53.53515625",
      "errAvgLoadTime": "0",
      "errCount": "0",
      "errDownloadSize": "0",
      "range": 8
    },
    "labels": [
      0,
      3,
      4,
      7,
      8
    ],
    "pageRespTimePerSec": [
      {
        "x": 0,
        "y": 0.175567
      },
...

Format: Default

An object response where metric data points is X: Y in the format..
The response includes summary results.
Labels for the known data points.
Data Section for each data point (pageRespTimePerSec,pageReqPerSec,pageKbPerSec,pageErrRespTime,pageErrCount,pageErrKb)

  "data": {
    "overview": {
      "avgLoadTime": "1.5104786666666699",
      "count": "10",
      "downloadSize": "155.4853515625",
      "errAvgLoadTime": "0",
      "errCount": "0",
      "errDownloadSize": "0",
      "range": 8
    },
    "labels": [
      0,
      2,
      3,
      4,
      7,
      8
    ],
    "pageRespTimePerSec": {
      "0": 0.353917,
      "2": 0.2109375,

...