latestOpenAPI 3.0.42026-08-19355873993.7 KB

fdb89a6eb2fb

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 no description 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 id of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.

ownerMailstring nullable

The mail of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.

organizationIdstring nullable

The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.

initialBoostLevelinteger nullable required

The initial boost level applied to the campaign of every run created from this benchmark. Null means the benchmark default is used.

scoreShiftnumber double required

Additive offset applied to displayed scores on the overall scoreboard of this benchmark.

scoreScalenumber double required

Multiplicative factor applied to displayed scores (relative to the Bradley-Terry center) on the overall scoreboard of this benchmark.

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 of them ever received votes.