Results

Operations related to Speedtest results. Requires an API token with scope results:read.

Fetch the single most recent result

get

Responses

200

OK

application/json

401

Unauthenticated

application/json

404

No result found

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/results/latest HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "service": "text",
  "ping": 1,
  "download": 1,
  "upload": 1,
  "download_bits": 1,
  "upload_bits": 1,
  "download_bits_human": "text",
  "upload_bits_human": "text",
  "benchmarks": [
    {}
  ],
  "healthy": true,
  "status": "text",
  "scheduled": true,
  "comments": "text",
  "data": {
    "isp": "text",
    "ping": {
      "low": 1,
      "high": 1,
      "jitter": 1,
      "latency": 1
    },
    "type": "text",
    "result": {
      "id": "text",
      "url": "https://example.com",
      "persisted": true
    },
    "server": {
      "id": 1,
      "ip": "0.0.0.0",
      "host": "text",
      "name": "text",
      "port": 1,
      "country": "text",
      "location": "text"
    },
    "upload": {
      "bytes": 1,
      "elapsed": 1,
      "latency": {
        "iqm": 1,
        "low": 1,
        "high": 1,
        "jitter": 1
      },
      "bandwidth": 1
    },
    "download": {
      "bytes": 1,
      "elapsed": 1,
      "latency": {
        "iqm": 1,
        "low": 1,
        "high": 1,
        "jitter": 1
      },
      "bandwidth": 1
    },
    "interface": {
      "name": "text",
      "isVpn": true,
      "macAddr": "text",
      "externalIp": "0.0.0.0",
      "internalIp": "0.0.0.0"
    },
    "timestamp": "2025-06-14T09:14:21.639Z",
    "packetLoss": 1
  },
  "created_at": "2025-06-14T09:14:21.639Z",
  "updated_at": "2025-06-14T09:14:21.639Z"
}

List results

get

Responses

200

OK

application/json

401

Unauthenticated

application/json

422

Validation failed

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/results HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "id": 1,
      "service": "text",
      "ping": 1,
      "download": 1,
      "upload": 1,
      "download_bits": 1,
      "upload_bits": 1,
      "download_bits_human": "text",
      "upload_bits_human": "text",
      "benchmarks": [
        {}
      ],
      "healthy": true,
      "status": "text",
      "scheduled": true,
      "comments": "text",
      "data": {
        "isp": "text",
        "ping": {
          "low": 1,
          "high": 1,
          "jitter": 1,
          "latency": 1
        },
        "type": "text",
        "result": {
          "id": "text",
          "url": "https://example.com",
          "persisted": true
        },
        "server": {
          "id": 1,
          "ip": "0.0.0.0",
          "host": "text",
          "name": "text",
          "port": 1,
          "country": "text",
          "location": "text"
        },
        "upload": {
          "bytes": 1,
          "elapsed": 1,
          "latency": {
            "iqm": 1,
            "low": 1,
            "high": 1,
            "jitter": 1
          },
          "bandwidth": 1
        },
        "download": {
          "bytes": 1,
          "elapsed": 1,
          "latency": {
            "iqm": 1,
            "low": 1,
            "high": 1,
            "jitter": 1
          },
          "bandwidth": 1
        },
        "interface": {
          "name": "text",
          "isVpn": true,
          "macAddr": "text",
          "externalIp": "0.0.0.0",
          "internalIp": "0.0.0.0"
        },
        "timestamp": "2025-06-14T09:14:21.639Z",
        "packetLoss": 1
      },
      "created_at": "2025-06-14T09:14:21.639Z",
      "updated_at": "2025-06-14T09:14:21.639Z"
    }
  ],
  "links": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "text",
        "label": "text",
        "active": true
      }
    ],
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Fetch a single result by ID

get

Path parameters

idintegerRequired

The ID of the result

Responses

200

OK

application/json

401

Unauthenticated

application/json

404

Result not found

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/results/{id} HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "id": 1,
    "service": "text",
    "ping": 1,
    "download": 1,
    "upload": 1,
    "download_bits": 1,
    "upload_bits": 1,
    "download_bits_human": "text",
    "upload_bits_human": "text",
    "benchmarks": [
      {}
    ],
    "healthy": true,
    "status": "text",
    "scheduled": true,
    "comments": "text",
    "data": {
      "isp": "text",
      "ping": {
        "low": 1,
        "high": 1,
        "jitter": 1,
        "latency": 1
      },
      "type": "text",
      "result": {
        "id": "text",
        "url": "https://example.com",
        "persisted": true
      },
      "server": {
        "id": 1,
        "ip": "0.0.0.0",
        "host": "text",
        "name": "text",
        "port": 1,
        "country": "text",
        "location": "text"
      },
      "upload": {
        "bytes": 1,
        "elapsed": 1,
        "latency": {
          "iqm": 1,
          "low": 1,
          "high": 1,
          "jitter": 1
        },
        "bandwidth": 1
      },
      "download": {
        "bytes": 1,
        "elapsed": 1,
        "latency": {
          "iqm": 1,
          "low": 1,
          "high": 1,
          "jitter": 1
        },
        "bandwidth": 1
      },
      "interface": {
        "name": "text",
        "isVpn": true,
        "macAddr": "text",
        "externalIp": "0.0.0.0",
        "internalIp": "0.0.0.0"
      },
      "timestamp": "2025-06-14T09:14:21.639Z",
      "packetLoss": 1
    },
    "created_at": "2025-06-14T09:14:21.639Z",
    "updated_at": "2025-06-14T09:14:21.639Z"
  },
  "message": "text"
}