Project Perf REST API


Query project performance metrics


โš ๏ธ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.

Query the performance metrics for a project. The query results are every permutation of each branch, testbed, benchmark, and measure. There is a limit of 255 permutations for a single request. Therefore, only the first 255 permutations are returned. 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.

Headers


Content-Type

string

Required

Set to application/json.


Authorization

string

Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.

Path Parameters


project

string

Required

The slug or UUID for a project.

Query Parameters


benchmarks

string

Required

A comma separated list of benchmark UUIDs to query.


branches

string

Required

A comma separated list of branch UUIDs to query.


end_time

integer

Search for metrics before the given date time in milliseconds.


heads

string

An optional comma separated list of branch head UUIDs. To not specify a particular branch head leave an empty entry in the list.


measures

string

Required

A comma separated list of measure UUIDs to query.


start_time

integer

Search for metrics after the given date time in milliseconds.


testbeds

string

Required

A comma separated list of testbed UUIDs to query.

GET
/v0/projects/{project}/perf
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher perf PROJECT

View OpenAPI Spec

Generate a dynamic image of project performance metrics


โš ๏ธ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.

Generate a dynamic image of performance metrics for a project. The query results are every permutation of each branch, testbed, benchmark, and measure. There is a limit of 8 permutations for a single image. Therefore, only the first 8 permutations are plotted. 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.

Headers


Content-Type

string

Required

Set to image/jpeg.


Authorization

string

Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.

Path Parameters


project

string

Required

The slug or UUID for a project.

Query Parameters


benchmarks

string

Required

A comma separated list of benchmark UUIDs to query.


branches

string

Required

A comma separated list of branch UUIDs to query.


end_time

integer

Search for metrics before the given date time in milliseconds.


heads

string

An optional comma separated list of branch head UUIDs. To not specify a particular branch head leave an empty entry in the list.


measures

string

Required

A comma separated list of measure UUIDs to query.


start_time

integer

Search for metrics after the given date time in milliseconds.


testbeds

string

Required

A comma separated list of testbed UUIDs to query.


title

string

The title for the perf plot. If not provided, the project name will be used.

GET
/v0/projects/{project}/perf/img
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

View OpenAPI Spec


Published: Mon, February 12, 2024 at 7:26:00 AM UTC | Last Updated: Fri, June 21, 2024 at 5:47:00 PM UTC