Project Plots REST API

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

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.

One of: index, title

---

Search by plot title or UUID.

---

Filter by plot title, exact match.

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

View OpenAPI Spec

Create a plot for a project. The user must have `create` permissions for the project. A project can have a maximum of 64 plots at a time.

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 benchmarks to include in the plot. At least one benchmark must be specified.

---

The branches to include in the plot. At least one branch must be specified.

---

The index of the plot. Maximum index is 64.

---

Display lower boundary limits.

---

Display metric lower values.

---

The measures to include in the plot. At least one measure must be specified.

---

The testbeds to include in the plot. At least one testbed must be specified.

---

The title of the plot. Maximum length is 64 characters.

---

Display upper boundary limits.

---

Display metric upper values.

---

The window of time for the plot, in seconds. Metrics outside of this window will be omitted.

---

The x-axis to use for the plot.

One of: date_time, version

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

View OpenAPI Spec

View a plot 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 UUID for a plot.

---

The slug or UUID for a project.

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

View OpenAPI Spec

Update a plot 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 UUID for a plot.

---

The slug or UUID for a project.

Body Parameters

---

The new index for the plot. Maximum index is 64.

---

The new title of the plot. Set to `null` to remove the current title. Maximum length is 64 characters.

---

The window of time for the plot, in seconds. Metrics outside of this window will be omitted.

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

View OpenAPI Spec

Delete a plot for a project. The user must have `delete` 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 UUID for a plot.

---

The slug or UUID for a project.

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

View OpenAPI Spec