BEbencherdev
projects
thresholds

Create a threshold

Changed on

Create a threshold for a project. The user must have create permissions for the project, or provide a valid project key for the project. There can only be one threshold for any unique combination of: branch, testbed, parameters filter, measure, and metric name. A threshold with no parameters filter checks every variant, and a threshold that names no metric checks the conventional value name. Every threshold that matches a metric row runs: there is no winner among them. A branch, testbed, and measure can have at most 64 thresholds with a model.

post/v0/projects/{project}/thresholds

Request

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

Path parameters

projectstring required

The slug or UUID for a project.

Request body

branchstring required
lower_boundarynumber double
max_sample_sizeinteger
measurestring required
metricstring

The name of a single scalar inside a metric.

Every name is equal on the wire. value, lower_value, and upper_value are conventional, not privileged: they are the names the metric triple maps onto, and the names the console knows well enough to draw a band.

min_sample_sizeinteger
parametersobject[]
test'static' | 'percentage' | 'z_score' | 't_test' | 'log_normal' | 'iqr' | 'delta_iqr' required
testbedstring required
upper_boundarynumber double
windowinteger

Response

successful creation

createdstring date-time required
metricstring

The name of a single scalar inside a metric.

Every name is equal on the wire. value, lower_value, and upper_value are conventional, not privileged: they are the names the metric triple maps onto, and the names the console knows well enough to draw a band.

modifiedstring date-time required
parametersobject[]
projectstring uuid required
uuidstring uuid required

Changes

  • 6b8d0bafd2ddRevision changes
    • 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

  • 1634d744359eRevision changes
    • info

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

    • info

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