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

ListBaselines

List all stored performance baselines with optional filtering.

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • profileTypeString

    Filter baselines by profile type; empty returns all types.

  • limitInteger

    Maximum number of baselines to return.

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Paginated list of baseline records.

    Example: (nested array)

    • baselineIdString

      Unique identifier of this baseline record.

      Example: bl-20240101

    • baselineLabelString

      Human-readable label identifying this baseline.

      Example: v1.2.0-release

    • profileTypeString

      Profile type this baseline was captured from.

      Example: cpu

    • sessionIdString

      Profiling session identifier used to create this baseline.

      Example: sess-abc123

    • descriptionString

      Optional description providing context for this baseline.

      Example: Post-deploy baseline for v1.2.0

    • topFunctionsList

      Top functions recorded at the time of baseline creation.

      Example: (nested array)

      • funcNameString

        Fully-qualified function name including package path.

        Example: runtime.gcBgMarkWorker

      • packageString

        Go package that contains this function.

        Example: runtime

      • selfPctLong

        Percentage of samples attributed solely to this function.

        Example: 12.5

      • cumulativePctLong

        Percentage of samples including callees of this function.

        Example: 18.3

      • sampleCountString

        Absolute number of profiling samples collected for this function.

        Example: 4200

    • createdAtString

      Timestamp when this baseline was created.

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

    • isLatestBoolean

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

      Example: true

    • tagsList

      User-defined tags for categorizing this baseline.

      Example: item1,item2

  • totalInteger

    Total number of baselines matching the filter criteria.

    Example: 42

  • limitInteger

    Maximum number of items returned per page.

    Example: 20

  • offsetInteger

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

    Example: 20

Endpoint

GET/api/v1/profiling/baselines

/api/v1/profiling/baselines

Operation ID

ListBaselines

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ],
  "total": 42,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history