BEbencherdev
projects
reports

Create a report

Changed on

Create a report for a project. The user must have create permissions for the project, or provide a valid project key 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.

post/v0/projects/{project}/reports

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

projectstring required

The slug or UUID for a project.

Request body

bmf_versioninteger

The Bencher Metric Format (BMF) version. The accepted versions are 0 or 1.

branchstring required
end_timestring date-time required
hashstring
resultsstring[] required

An array of benchmarks results in Bencher Metric Format (BMF).

start_timestring date-time required
testbedstring required

Response

successful creation

adapter'magic' | 'json' | 'json_v0' | 'json_v1' | 'rust' | 'rust_bench' | 'rust_criterion' | 'rust_iai' | 'rust_gungraun' | 'rust_gungraun_stdout' | 'rust_gungraun_json' | 'cpp' | 'cpp_google' | 'cpp_catch2' | 'go' | 'go_bench' | 'java' | 'java_jmh' | 'c_sharp' | 'c_sharp_dot_net' | 'js' | 'js_benchmark' | 'js_time' | 'js_vitest' | 'python' | 'python_asv' | 'python_pytest' | 'ruby' | 'ruby_benchmark' | 'shell' | 'shell_hyperfine' | 'shell_hyperfine_v1' | 'shell_hyperfine_v2' | 'dart' | 'dart_benchmark_harness' required
createdstring date-time required
end_timestring date-time required
jobstring uuid
start_timestring date-time required
uuidstring uuid required

Changes

  • fa0ddcf7e9f7Revision changes
    • info

      added the new optional request property /////

  • 4187623dc587Revision changes
    • warning

      added the new shell_hyperfine_v1 enum value to the response property for the response status

    • warning

      added the new shell_hyperfine_v2 enum value to the response property for the response status

    • info

      added the new shell_hyperfine_v1 enum value to the request property /////////

    • info

      added the new shell_hyperfine_v2 enum value to the request property /////////