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
Set to application/json.
Authorization string
Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.
Path Parameters
projectstring
The slug or UUID for a project.
Query Parameters
benchmarksstring
A comma separated list of benchmark UUIDs to query.
branchesstring
A comma separated list of branch UUIDs to query.
end_timeinteger
Search for metrics before the given date time in milliseconds.
headsstring
An optional comma separated list of branch head UUIDs. To not specify a particular branch head leave an empty entry in the list.
measuresstring
A comma separated list of measure UUIDs to query.
start_timeinteger
Search for metrics after the given date time in milliseconds.
testbedsstring
A comma separated list of testbed UUIDs to query.
/v0/projects/{project}/perf | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:61016 |
Bencher CLI
bencher perf PROJECTView 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
Set to image/jpeg.
Authorization string
Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.
Path Parameters
projectstring
The slug or UUID for a project.
Query Parameters
benchmarksstring
A comma separated list of benchmark UUIDs to query.
branchesstring
A comma separated list of branch UUIDs to query.
end_timeinteger
Search for metrics before the given date time in milliseconds.
headsstring
An optional comma separated list of branch head UUIDs. To not specify a particular branch head leave an empty entry in the list.
measuresstring
A comma separated list of measure UUIDs to query.
start_timeinteger
Search for metrics after the given date time in milliseconds.
testbedsstring
A comma separated list of testbed UUIDs to query.
titlestring
The title for the perf plot. If not provided, the project name will be used.
/v0/projects/{project}/perf/img | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:61016 |
View OpenAPI Spec