Skip to main content
ZStack
Monitoring & Collection/Profiling

CheckRegression

Check for performance regression between a baseline and a comparison profile.

POST/api/v1/profiling/regression/check

Operation ID

CheckRegression

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • baselineId
    StringRequired

    Unique identifier of the baseline to check against.

    Example: bl-20240101

  • compareId
    StringRequired

    Identifier of the profile or session to compare against the baseline.

    Example: sess-cmp002

  • thresholds
    ObjectRequired

    Custom thresholds controlling regression detection sensitivity.

    • functionDeltaPct
      Long

      Minimum percentage change to classify a function as regressed.

      Example: 5

    • newHotspotMinPct
      Long

      Minimum percentage for a new function to be considered a hotspot.

      Example: 2

    • criticalDeltaPct
      Long

      Delta percentage that triggers a critical severity regression.

      Example: 20

    • criticalHotspotPct
      Long

      Hotspot percentage that triggers a critical severity classification.

      Example: 10

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • reportId
    String

    Unique identifier of this regression report.

    Example: rpt-xyz789

  • baselineLabel
    String

    Label of the baseline used in the regression check.

    Example: v1.2.0-release

  • compareLabel
    String

    Label of the comparison profile used in the regression check.

    Example: v1.3.0-candidate

  • profileType
    String

    Profile type used for this regression analysis.

    Example: cpu

  • regressionDetected
    Boolean

    Whether a performance regression was detected.

    Example: true

  • severity
    String

    Severity level of the detected regression.

    Example: WARNING

  • changedFunctions
    List

    Functions whose CPU usage changed between baseline and comparison.

    Example: (nested array)

    • funcName
      String

      Fully-qualified name of the function that changed.

      Example: net/http.(*Transport).roundTrip

    • baselinePct
      Long

      Function's CPU percentage in the baseline profile.

      Example: 3.2

    • comparePct
      Long

      Function's CPU percentage in the comparison profile.

      Example: 8.7

    • deltaPct
      Long

      Absolute change in percentage between baseline and comparison.

      Example: 5.5

    • direction
      String

      Direction of change for this function's resource usage.

      Example: increased

  • newHotspots
    List

    New hotspot functions appearing in the comparison profile.

    Example: (nested array)

    • funcName
      String

      Fully-qualified name of the function that changed.

      Example: net/http.(*Transport).roundTrip

    • baselinePct
      Long

      Function's CPU percentage in the baseline profile.

      Example: 3.2

    • comparePct
      Long

      Function's CPU percentage in the comparison profile.

      Example: 8.7

    • deltaPct
      Long

      Absolute change in percentage between baseline and comparison.

      Example: 5.5

    • direction
      String

      Direction of change for this function's resource usage.

      Example: increased

  • disappearedHotspots
    List

    Hotspot functions that disappeared from the comparison profile.

    Example: (nested array)

    • funcName
      String

      Fully-qualified name of the function that changed.

      Example: net/http.(*Transport).roundTrip

    • baselinePct
      Long

      Function's CPU percentage in the baseline profile.

      Example: 3.2

    • comparePct
      Long

      Function's CPU percentage in the comparison profile.

      Example: 8.7

    • deltaPct
      Long

      Absolute change in percentage between baseline and comparison.

      Example: 5.5

    • direction
      String

      Direction of change for this function's resource usage.

      Example: increased

  • createdAt
    String

    Timestamp when this regression report was created.

    Example: 2026-01-15T08:00:00Z