Sign in
Benchmark

Returns a single benchmark by its id.

get/benchmark/{benchmarkId}

Path parameters

benchmarkIdstring required

The id of the benchmark to load.

Response

OK

idstring required

The unique identifier of the benchmark.

namestring required

The name of the benchmark.

descriptionstring nullable required

Optional plain-text credit for the people or sources behind the benchmark; null when none was supplied.

isPublicboolean required

Whether the benchmark is public.

isPublishedboolean required

Whether the benchmark is published to the public benchmark repository.

createdAtstring date-time required

The timestamp when the benchmark was created.

ownerIdstring uuid nullable

The benchmark's owner; null unless the caller is platform staff or in the owning organization.

ownerMailstring nullable

The owner's mail; null unless the caller is platform staff or in the owning organization.

organizationIdstring nullable

The owner's organization; null unless the caller is platform staff or in the owning organization.

initialBoostLevelinteger nullable required

Initial boost level applied to every run's campaign; null uses the benchmark default.

scoreShiftnumber double required

Additive offset applied to displayed scores on the benchmark's overall scoreboard.

scoreScalenumber double required

Multiplicative factor applied to displayed scores on the benchmark's overall scoreboard, relative to the Bradley-Terry center.

lastUpdatedAtstring date-time nullable required

When the benchmark's rankings last changed — the latest vote recording across the leaderboards contributing to its overall; null when none ever received votes.

Changes