Skip to content

Compare 2 to 10 runs

GET
/v1/runs/compare
curl --request GET \
--url 'https://beta-api.plune.ai/v1/runs/compare?ids=example' \
--header 'Authorization: Bearer <token>'

T14 (#1275). The runs are put in the order they were created; every verdict is between the newest and the one before it. regressed: passed before, failed or broke now. improved: the opposite. degraded: passed in both and took 30 % or more longer. A muted failure is not a failure. In a run with configurations (#1251) a case is the worst of its combinations, each by its latest result. flaky is the case’s own flag, beside the verdict. notMeasured is never absent and says what was not judged (a case missing from one of the two runs, a passed case without a duration, cost: a result carries none), as codes with numbers the client words in the reader’s language: no_verdict (count of total), no_duration (count), cost_not_compared. The dashboard draws this same answer.

ids
required
string

Run ids, comma separated; 2 to 10.

The comparison

Media type application/json
object
runs
required
Array<object>
object
id
required
string
title
required
string
nullable
createdAt
required
string format: date-time
previousRunId
required
string
newestRunId
required
string
counters
required
object
compared
required

The cases with a result in both of the last two runs - the denominator of regressed, improved and degraded.

integer
regressed
required
integer
improved
required
integer
degraded
required
integer
flaky
required

Of cases, those flagged flaky.

integer
cases
required
integer
cases
required
Array<object>
object
caseId
required
string
title
required
string
flaky
required
boolean
cells
required

One per run, in the order of runs; null: no result in that run.

Array<object>
object
status
string
durationMs
integer
nullable
verdict
required
string
nullable
Allowed values: regressed improved degraded same
notMeasured
required

What the comparison did not judge: a code and its numbers, never a sentence. [] means it measured all it set out to.

Array<object>
object
code
required
string
Allowed values: no_verdict no_duration cost_not_compared
params

no_verdict: count, total. no_duration: count. cost_not_compared: none.

object
key
additional properties
integer
Example
{
"cases": [
{
"verdict": "regressed"
}
],
"notMeasured": [
{
"code": "no_verdict"
}
]
}

Fewer than 2 or more than 10 run ids

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No / invalid token or session

One of the runs is not found or not yours

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}