BEbencherdev
projects
variants

List variants for a benchmark

Changed on

List all variants for a benchmark. If the project is public, then the user does not need to be authenticated. If the project is private, then the user must be authenticated and have view permissions for the project, or provide a valid project key for the project. By default, the variants are sorted by creation date time. The HTTP response header X-Total-Count contains the total number of variants.

get/v0/projects/{project}/benchmarks/{benchmark}/variants

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

benchmarkstring required

The slug or UUID for a benchmark.

projectstring required

The slug or UUID for a project.

Query parameters

direction'asc' | 'desc'

The direction to sort by. If not specified, the default sort direction is used.

pageinteger nullable

The page number to return. If not specified, the first page is returned.

per_pageinteger nullable

The number of items to return per page. If not specified, the default number of items per page (8) is used.

'created'

Sort by variant creation date time.

OR
'last_used'

Sort by the variant's newest report, newest first when no direction is given, with the never reported last either way.

The field to sort by. If not specified, the default sort field is used.

archivedboolean nullable

If set to true, only returns archived variants. If not set or set to false, only returns non-archived variants.

Response

successful operation

archivedstring date-time
benchmarkstring uuid required
createdstring date-time required
modifiedstring date-time required
parametersParameterSet required
uuidstring uuid required

Changes