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

CreateBaseline

Create a new performance baseline from a profiling session.

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • labelStringRequired

    Human-readable label for the new baseline.

    Example: v1.2.0-release

  • sessionIdStringRequired

    Session identifier to use as the source of this baseline.

    Example: sess-abc123

  • profileTypeStringRequired

    Profile type this baseline represents.

    Example: cpu

  • descriptionStringRequired

    Optional description providing context for this baseline.

    Example: Post-deploy baseline for v1.2.0

  • topFunctionsListRequired

    Top functions captured from the source session.

    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

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

POST/api/v1/profiling/baselines

/api/v1/profiling/baselines

Operation ID

CreateBaseline

Permalink

Request Example

curl -X POST '{host}/api/v1/profiling/baselines' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"label":"v1.2.0-release","sessionId":"sess-abc123","profileType":"cpu","description":"Post-deploy baseline for v1.2.0","topFunctions":"(nested array)"}'

Response Example

200
{
  "baselineId": "bl-20240101",
  "baselineLabel": "v1.2.0-release",
  "profileType": "cpu",
  "sessionId": "sess-abc123",
  "description": "Post-deploy baseline for v1.2.0",
  "topFunctions": [
    {}
  ],
  "createdAt": "example",
  "isLatest": true
}

Change History

This API has no change history records yet.

View all change history