Project Plots REST API

List plots for a project

โš ๏ธ 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.

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

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

direction

string

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

Default: asc

One of: asc, desc

page

integer

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

Default: 1

per_page

integer

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

Default: 8

sort

string

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

One of: index, title

search

string

Search by plot title or UUID.

title

string

Filter by plot title, exact match.

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

Bencher CLI

bencher plot list PROJECT

View OpenAPI Spec

Create a plot

โš ๏ธ 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.

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

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

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.

Body Parameters

benchmarks
Required

The benchmarks to include in the plot. At least one benchmark must be specified.

branches
Required

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

index

integer

The index of the plot. Maximum index is 64.

lower_boundary

boolean

Required

Display lower boundary limits.

lower_value

boolean

Required

Display metric lower values.

measures
Required

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

testbeds
Required

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

title

string

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

upper_boundary

boolean

Required

Display upper boundary limits.

upper_value

boolean

Required

Display metric upper values.

window

integer

Required

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

x_axis

string

Required

The x-axis to use for the plot.

One of: date_time, version

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

Bencher CLI

bencher plot create PROJECT

View OpenAPI Spec

View a plot

โš ๏ธ 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.

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

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

plot

string

Required

The UUID for a plot.

project

string

Required

The slug or UUID for a project.

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

Bencher CLI

bencher plot view PROJECT PLOT

View OpenAPI Spec

Update a plot

โš ๏ธ 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.

Update a plot for a project. The user must have `edit` permissions for the project.

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

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

Path Parameters

plot

string

Required

The UUID for a plot.

project

string

Required

The slug or UUID for a project.

Body Parameters

index

integer

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

title

string

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

window

integer

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

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

Bencher CLI

bencher plot update PROJECT PLOT

View OpenAPI Spec

Delete a plot

โš ๏ธ 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.

Delete a plot for a project. The user must have `delete` permissions for the project.

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

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

Path Parameters

plot

string

Required

The UUID for a plot.

project

string

Required

The slug or UUID for a project.

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

Bencher CLI

bencher plot delete PROJECT PLOT

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