GET
/
v1
/
benchmarks
/
runs
/
{id}
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: 'My Bearer Token',
});

const benchmarkRunView = await client.benchmarks.runs.retrieve('id');

console.log(benchmarkRunView.id);
{
  "id": "<string>",
  "benchmark_id": "<string>",
  "name": "<string>",
  "start_time_ms": 123,
  "duration_ms": 123,
  "state": "running",
  "score": 123,
  "metadata": {},
  "purpose": "<string>",
  "environment_variables": {},
  "secrets_provided": {}
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The BenchmarkRun ID.

Response

200 - application/json

OK

A BenchmarkRunView represents a run of a complete set of Scenarios, organized under a Benchmark.

​
id
string
required

The ID of the BenchmarkRun.

​
benchmark_id
string
required

The ID of the Benchmark.

​
start_time_ms
integer
required

The time the benchmark run execution started (Unix timestamp milliseconds).

​
state
enum<string>
required

The state of the BenchmarkRun.

Available options:
running,
canceled,
completed
​
metadata
object
required

User defined metadata to attach to the benchmark run for organization.

​
name
string | null

The name of the BenchmarkRun.

​
duration_ms
integer | null

The duration for the BenchmarkRun to complete.

​
score
number | null

The final score across the BenchmarkRun, present once completed. Calculated as sum of scenario scores / number of scenario runs.

​
purpose
string | null

Purpose of the run.

​
environment_variables
object | null

Environment variables used to run the benchmark.

​
secrets_provided
object | null

User secrets used to run the benchmark. Example: {"DB_PASS": "DATABASE_PASSWORD"} would set the environment variable 'DB_PASS' on all scenario devboxes to the value of the secret 'DATABASE_PASSWORD'.