Skip to main content
ZStack
Monitoring & Collection/Profiling

ListBaselines

List all stored performance baselines with optional filtering.

GET/api/v1/profiling/baselines

Operation ID

ListBaselines

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

Query Parameters

  • profileType
    String

    Filter baselines by profile type; empty returns all types.

  • limit
    Integer

    Maximum number of baselines to return.

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Paginated list of baseline records.

    Example: (nested array)

    • baselineId
      String

      Unique identifier of this baseline record.

      Example: bl-20240101

    • baselineLabel
      String

      Human-readable label identifying this baseline.

      Example: v1.2.0-release

    • profileType
      String

      Profile type this baseline was captured from.

      Example: cpu

    • sessionId
      String

      Profiling session identifier used to create this baseline.

      Example: sess-abc123

    • description
      String

      Optional description providing context for this baseline.

      Example: Post-deploy baseline for v1.2.0

    • topFunctions
      List

      Top functions recorded at the time of baseline creation.

      Example: (nested array)

      • funcName
        String

        Fully-qualified function name including package path.

        Example: runtime.gcBgMarkWorker

      • package
        String

        Go package that contains this function.

        Example: runtime

      • selfPct
        Long

        Percentage of samples attributed solely to this function.

        Example: 12.5

      • cumulativePct
        Long

        Percentage of samples including callees of this function.

        Example: 18.3

      • sampleCount
        String

        Absolute number of profiling samples collected for this function.

        Example: 4200

    • createdAt
      String

      Timestamp when this baseline was created.

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

    • isLatest
      Boolean

      Whether this is the most recently created baseline for its type.

      Example: true

    • tags
      List

      User-defined tags for categorizing this baseline.

      Example: item1,item2

  • total
    Integer

    Total number of baselines matching the filter criteria.

    Example: 42

  • limit
    Integer

    Maximum number of items returned per page.

    Example: 20

  • offset
    Integer

    Zero-based offset of the first item in the current page.

    Example: 20