Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Profiling
GETProfilingSince 1.0SynchronousAuth Required

GetRegressionReport

Get a single regression report by its identifier.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • reportIdStringRequired

    Unique identifier of the regression report to retrieve.

Responses

200 OK

On success, this API returns the following response structure.

  • reportIdString

    Unique identifier of this regression report.

    Example: rpt-xyz789

  • baselineLabelString

    Label of the baseline used in the regression check.

    Example: v1.2.0-release

  • compareLabelString

    Label of the comparison profile used in the regression check.

    Example: v1.3.0-candidate

  • profileTypeString

    Profile type used for this regression analysis.

    Example: cpu

  • regressionDetectedBoolean

    Whether a performance regression was detected.

    Example: true

  • severityString

    Severity level of the detected regression.

    Example: WARNING

  • changedFunctionsList

    Functions whose CPU usage changed between baseline and comparison.

    Example: (nested array)

    • funcNameString

      Fully-qualified name of the function that changed.

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

    • baselinePctLong

      Function's CPU percentage in the baseline profile.

      Example: 3.2

    • comparePctLong

      Function's CPU percentage in the comparison profile.

      Example: 8.7

    • deltaPctLong

      Absolute change in percentage between baseline and comparison.

      Example: 5.5

    • directionString

      Direction of change for this function's resource usage.

      Example: increased

  • newHotspotsList

    New hotspot functions appearing in the comparison profile.

    Example: (nested array)

    • funcNameString

      Fully-qualified name of the function that changed.

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

    • baselinePctLong

      Function's CPU percentage in the baseline profile.

      Example: 3.2

    • comparePctLong

      Function's CPU percentage in the comparison profile.

      Example: 8.7

    • deltaPctLong

      Absolute change in percentage between baseline and comparison.

      Example: 5.5

    • directionString

      Direction of change for this function's resource usage.

      Example: increased

  • disappearedHotspotsList

    Hotspot functions that disappeared from the comparison profile.

    Example: (nested array)

    • funcNameString

      Fully-qualified name of the function that changed.

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

    • baselinePctLong

      Function's CPU percentage in the baseline profile.

      Example: 3.2

    • comparePctLong

      Function's CPU percentage in the comparison profile.

      Example: 8.7

    • deltaPctLong

      Absolute change in percentage between baseline and comparison.

      Example: 5.5

    • directionString

      Direction of change for this function's resource usage.

      Example: increased

  • createdAtString

    Timestamp when this regression report was created.

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

Endpoint

GET/api/v1/profiling/regression/reports/{reportId}

/api/v1/profiling/regression/reports/{reportId}

Operation ID

GetRegressionReport

Permalink

Request Example

curl -X GET '{host}/api/v1/profiling/regression/reports/{reportId}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "reportId": "rpt-xyz789",
  "baselineLabel": "v1.2.0-release",
  "compareLabel": "v1.3.0-candidate",
  "profileType": "cpu",
  "regressionDetected": true,
  "severity": "WARNING",
  "changedFunctions": [
    {}
  ],
  "newHotspots": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history