Sign in
Leaderboard

Gets a leaderboard by its id.

get/leaderboard/{leaderboardId}

Path parameters

leaderboardIdstring required

The id of the leaderboard to retrieve.

Response

OK

idstring required

The unique identifier of the leaderboard.

namestring required

The name of the leaderboard.

instructionstring required

The instruction used when collecting responses.

showPromptboolean required

Whether the prompt is shown on the rapids.

showPromptAssetboolean required

Whether the prompt asset is shown on the rapids.

isInversedboolean required

Whether the leaderboard results are inversed.

responseBudgetinteger required

The response budget per run.

minResponsesinteger required

The minimum responses collected per comparison.

audienceIdstring required

The id of the audience that evaluates the leaderboard.

jobDefinitionIdstring nullable

The id of the associated job definition, if any.

priorityinteger nullable

Priority override applied to every run's job. Null when no override is set; runs then fall back to the default leaderboard priority.

weightnumber double required

Multiplier applied to every match result from this leaderboard when it contributes to the parent benchmark's overall / combined scoreboards.

scoreShiftnumber double required

Additive offset applied to displayed scores on this leaderboard's per-leaderboard scoreboard.

scoreScalenumber double required

Multiplicative factor applied to displayed scores (relative to the Bradley-Terry center) on this leaderboard's per-leaderboard scoreboard.

isHiddenboolean required

Whether the leaderboard is hidden in listings and reads for non-admins.

isExcludedFromOverallboolean required

Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard, making it an owner-only private experiment.

voteAggregation'AllVotes' | 'MajorityVote' required
includedTagsstring[] required

Prompt tag values the leaderboard restricts its matchups to. Empty means no restriction.

excludedTagsstring[] required

Prompt tag values the leaderboard never creates matchups for. Takes precedence over includedTags.

lastUpdatedAtstring date-time nullable required

When votes were last recorded for the leaderboard. Null when no run has ever delivered votes to it.

Changes

Changed in 1 of the 6 revisions of this API.1