BEbencherdev
projects
reports

List reports for a project

Changed on

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, or provide a valid project key for the project. By default, the reports are sorted by date time in reverse chronological order. By default, the results and alerts for each report are omitted and only their counts are included. Set the expand query param to true to include the full results and alerts. The HTTP response header X-Total-Count contains the total number of reports.

get/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.

Query parameters

direction'asc' | 'desc'

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

pageinteger nullable

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

per_pageinteger nullable

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

sort'date_time'

Sort by date time.

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

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'

Filter by adapter, as reports list it: a language adapter such as rust is listed as magic.

alerts'active'

Reports with at least one active alert.

If set to active, only return reports with at least one active alert.

archivedboolean nullable

If set to true, only return reports with an archived branch or testbed. If not set or set to false, only returns reports with non-archived branches and testbeds.

branchstring nullable

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

end_timeinteger

Filter for reports before the given date time in milliseconds.

expandboolean nullable

If set to true, include the full results and alerts for each report. If not set or set to false, the results and alerts are omitted and only the counts are included.

start_timeinteger

Filter for reports after the given date time in milliseconds.

testbedstring nullable

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

Response

successful operation

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

  • 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 enum value shell_hyperfine_v1 to the query request parameter adapter

    • info

      added the new enum value shell_hyperfine_v2 to the query request parameter adapter

  • edcaa65c5a0bRevision changes
    • info

      added the new optional query request parameter adapter

    • info

      added the new optional query request parameter alerts

    • info

      added the optional property //////// to the response with the status