Get the benchmark leaderboard

Returns one ranked page of a suite version’s published targets, each with the metric cells it is judged on. Ranking happens in the database, so paging through the board is consistent. Every default the server applies (suite version, condition, sort metric, sort direction) is echoed on the response, so a page can be cited without guessing how it was ordered.

GET /v1/benchmark/leaderboard

JavaScript

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.benchmark.getLeaderboard({ suite: 'x' });

console.log(response.data);

200

{
  "data": [
    {
      "target": {
        "targetKey": "<string>",
        "targetName": "<string>",
        "suite": "<string>",
        "suiteVersion": "<string>",
        "publicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "iterations": 123,
        "sampleCallCount": 123,
        "publishedAt": "<string>",
        "supersededAt": "<string>",
        "isCurrent": true
      },
      "metrics": [
        {
          "conditionKey": "<string>",
          "conditionLabel": "<string>",
          "metricKey": "<string>",
          "metricName": "<string>",
          "metricKind": "NUMERIC",
          "unitSymbol": "<string>",
          "n": 123,
          "p50": 123,
          "p95": 123,
          "mean": 123,
          "ciLow": 123,
          "ciHigh": 123,
          "passRate": 123,
          "passRateCiLow": 123,
          "passRateCiHigh": 123
        }
      ]
    }
  ],
  "suite": "<string>",
  "suiteVersion": "<string>",
  "conditionKey": "<string>",
  "sortedBy": {
    "metricKey": "<string>",
    "order": "asc"
  },
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasMore": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

suite · string · required

Minimum string length: 1

suiteVersion · string

Minimum string length: 1

conditionKey · string

sortBy · string

Minimum string length: 1

order · enum<string>

Available options: asc, desc

metrics · string

Comma-separated metric keys to project per row. Defaults to the headline set.

limit · integer · default: 20

Maximum number of records to return (default: 20, max: 100)

Required range: 1 <= x <= 100

offset · integer · default: 0

Pagination offset

Required range: x >= 0

Response

200

application/json

One ranked page of the leaderboard

data · object[] · required

Show child attributes

suite · string · required

suiteVersion · string · required

The version actually read, after defaulting.

conditionKey · string · required

sortedBy · object · required

The ranking this page was produced under

Show child attributes

pagination · object · required

Show child attributes