Project Benchmarks REST API

List all benchmarks 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 benchmarks are sorted in alphabetical order by name. The HTTP response header `X-Total-Count` contains the total number of benchmarks.

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: name

One of: name

---

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

---

Filter by benchmark name, exact match.

---

Search by benchmark name, slug, or UUID.

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

View OpenAPI Spec

Create a benchmark for a project. The user must have `create` 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.

Body Parameters

---

The name of the benchmark. Maximum length is 1,024 characters.

---

The preferred slug for the benchmark. If not provided, the slug will be generated from the name. If the provided or generated slug is already in use, a unique slug will be generated. Maximum length is 64 characters.

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

View OpenAPI Spec

View a benchmark 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 benchmark.

---

The slug or UUID for a project.

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

View OpenAPI Spec

Update a benchmark for a project. The user must have `edit` 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 benchmark.

---

The slug or UUID for a project.

Body Parameters

---

Set whether the benchmark is archived.

---

The new name of the benchmark. Maximum length is 1,024 characters.

---

The preferred new slug for the benchmark. Maximum length is 64 characters.

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

View OpenAPI Spec

Delete a benchmark for a project. The user must have `delete` permissions for the project. All reports that use this benchmark must be deleted first!

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 benchmark.

---

The slug or UUID for a project.

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

View OpenAPI Spec