projects
plots

Create a plot for a project. The user must have create permissions for the project, or provide a valid project key for the project. A project can have a maximum of 64 plots at a time.

post/v0/projects/{project}/plots

Request

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

Path parameters

projectstring required

The slug or UUID for a project.

Request body

benchmarksBenchmarkUuid[] required

The benchmarks to include in the plot. At least one benchmark must be specified, and at most 8.

branchesBranchUuid[] required

The branches to include in the plot. At least one branch must be specified, and at most 8.

focusstring

An opaque key naming one line of a plot. A line key is 1 to 16 URL-safe characters: A-Z, a-z, 0-9, -, and _.

hiddenLineKey[]
indexinteger
lower_boundaryboolean required

Display lower boundary limits.

lower_valueboolean required

Display metric lower values.

measuresMeasureUuid[] required

The measures to include in the plot. At least one measure must be specified, and at most 8.

metricsMetricName[]
parametersobject[]
testbedsTestbedUuid[] required

The testbeds to include in the plot. At least one testbed must be specified, and at most 8.

titlestring
upper_boundaryboolean required

Display upper boundary limits.

upper_valueboolean required

Display metric upper values.

windowinteger required
x_axis'date_time' | 'version' required

Response

successful creation

benchmarksBenchmarkUuid[] required
branchesBranchUuid[] required
createdstring date-time required
focusstring

An opaque key naming one line of a plot. A line key is 1 to 16 URL-safe characters: A-Z, a-z, 0-9, -, and _.

hiddenLineKey[]
lower_boundaryboolean required
lower_valueboolean required
measuresMeasureUuid[] required
metricsMetricName[]
modifiedstring date-time required
parametersobject[]
projectstring uuid required
testbedsTestbedUuid[] required
titlestring
upper_boundaryboolean required
upper_valueboolean required
uuidstring uuid required
windowinteger required
x_axis'date_time' | 'version' required

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status