Skip to main content
GET
Compare deployment performance
Required permissions: alert.read. Personal keys are capped by their owner’s current team role. See request conventions and automation workflows. MCP clients use the task-oriented tool catalogue.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

deployableId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

baselineId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
candidateId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
windowMinutes
integer
default:30
Required range: 5 <= x <= 1440
warmupMinutes
integer
default:2
Required range: 0 <= x <= 60
regressionPercent
number
default:0
Required range: 0 <= x <= 500
minimumCoveragePercent
number
default:0
Required range: 0 <= x <= 100
statistic
enum<string>
default:average
Available options:
average,
peak
cpuFloorCores
number
default:0
Required range: 0 <= x <= 1024
memoryFloorMiB
number
default:0
Required range: 0 <= x <= 1048576

Response

Equal relative observation windows, aligned metrics, sample coverage, changes and comparison limitations.

workload
object
required
query
object
required
stepSeconds
number
required
baseline
object
required
candidate
object
required
metrics
object[]
required
restarts
object
required
warnings
string[]
required
localization
object
required
Last modified on September 6, 2026