BEbencherdev
projects
perf

Query project performance metrics

Changed on

Query the performance metrics for a project. The query results are every permutation of each branch, testbed, benchmark, and measure. Each permutation returns one line per variant of its benchmark, narrowed by the parameters filter when one is given. Only the first 8 entries of each dimension list are queried, and only the first 8 entries of the parameters filter are read. A parameters entry that is not a valid parameter set is dropped, and when every entry is dropped there are no lines. There is a limit of 64 permutations and 64 lines for a single request. A permutation with nothing to plot returns no line, but it still counts against the permutation limit. If there is no start_time, then the last four weeks are queried, back from the end_time when there is one and from now when there is not. The response always states the window that was queried. 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.

get/v0/projects/{project}/perf

Request

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

Path parameters

projectstring required

The slug or UUID for a project.

Query parameters

benchmarksstring required

A comma separated list of benchmark UUIDs to query. Only the first 8 benchmarks are queried.

branchesstring required

A comma separated list of branch UUIDs to query. Only the first 8 branches are queried.

end_timeinteger

Search for metrics before the given date time in milliseconds.

headsstring nullable

An optional comma separated list of branch head UUIDs. To not specify a particular branch head leave an empty entry in the list.

measuresstring required

A comma separated list of measure UUIDs to query. Only the first 8 measures are queried.

parametersstring nullable

An optional comma separated list of URL encoded parameters to filter on. A variant is queried when at least one of them is a subset of its parameters: every key the filter names, with the same value. Leaving this off queries every variant. Only the first 8 are read, and of those, any that is not a valid parameter set is dropped, since no variant could match it. When every entry is dropped, no variant is queried.

specsstring nullable

An optional comma separated list of testbed spec UUIDs. To not specify a particular testbed spec leave an empty entry in the list.

start_timeinteger

Search for metrics after the given date time in milliseconds. Defaults to four weeks before the end time, or four weeks before now when there is no end time.

testbedsstring required

A comma separated list of testbed UUIDs to query. Only the first 8 testbeds are queried.

Response

successful operation

end_timestring date-time
start_timestring date-time

Changes

  • 6b8d0bafd2ddRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

  • 2ca549d2a218Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

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