Project Reports REST API

List all reports for a project. 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. By default, the reports are sorted by date time in reverse chronological order.

Headers

---

Set to application/json.

---

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

Path Parameters

---

The slug or UUID for a project.

Query Parameters

---

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

Default: asc

One of: asc, desc

---

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

Default: 1

---

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

Default: 8

---

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

Default: date_time

One of: date_time

---

Filter by branch UUID, slug, or name exact match.

---

Filter for reports before the given date time in milliseconds.

---

Filter for reports after the given date time in milliseconds.

---

Filter by testbed UUID, slug, or name exact match.

Bencher Cloud	https://api.bencher.dev
Bencher Self-Hosted	http://localhost:61016

View OpenAPI Spec

Create a report for a project. The user must have `create` permissions for the project. If using the Bencher CLI, it is recommended to use the `bencher run` subcommand instead of trying to create a report manually.

Headers

---

Set to application/json.

---

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

Path Parameters

---

The slug or UUID for a project.

Body Parameters

---

Branch UUID, slug, or name.

---

End time for the report. Must be an ISO 8601 formatted string.

---

Full `git` commit hash. All reports with the same `git` commit hash will be considered part of the same branch version. This can be useful for tracking the performance of a specific commit across multiple testbeds.

---

An array of benchmarks results.

---

Settings for how to handle the report.

Properties of settings

---

adapter

string

The benchmark harness adapter for parsing the benchmark results. If no adapter is specified, then the Magic adapter will be used.

Default: magic

One of: magic, json, rust, rust_bench, rust_criterion, rust_iai, rust_iai_callgrind, cpp, cpp_google, cpp_catch2, go, go_bench, java, java_jmh, c_sharp, c_sharp_dot_net, js, js_benchmark, js_time, python, python_asv, python_pytest, ruby, ruby_benchmark, shell, shell_hyperfine

---

average

string

Benchmark harness suggested central tendency (ie average). Some benchmarking harnesses provide multiple averages, such as mean and median.

One of: mean, median

---

fold

string

Fold multiple results into a single result using the selected operation. This can be useful for taking the min, max, mean, or median of the benchmark results.

One of: min, max, mean, median

---

Start time for the report. Must be an ISO 8601 formatted string.

---

Testbed UUID, slug, or name.

Bencher Cloud	https://api.bencher.dev
Bencher Self-Hosted	http://localhost:61016

View OpenAPI Spec

View a report for a project. 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

---

Set to application/json.

---

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

Path Parameters

---

The slug or UUID for a project.

---

The UUID for a report.

Bencher Cloud	https://api.bencher.dev
Bencher Self-Hosted	http://localhost:61016

View OpenAPI Spec

Delete a report for a project. The user must have `delete` permissions for the project. If there are no more reports for a branch version, then that version will be deleted. All later branch versions will have their version numbers decremented.

Headers

---

Set to application/json.

---

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

Path Parameters

---

The slug or UUID for a project.

---

The UUID for a report.

Bencher Cloud	https://api.bencher.dev
Bencher Self-Hosted	http://localhost:61016

View OpenAPI Spec