Test History

Compare test metrics

Compare test metrics between two commits or two test runs. Provide either (beforeCommit + afterCommit) or (beforeRunId + afterRunId).

get/api/v1/user/projects/{projectId}/compare-test

Request

  • Base URL: https://app.gaffer.sh
  • URL: https://app.gaffer.sh/api/v1/user/projects/{projectId}/compare-test
  • Auth: one of:
    • API key in header X-API-Key
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

projectIdstring required

Project ID. Use the list projects endpoint to find project IDs.

Query parameters

testNamestring required

The test name to compare

beforeCommitstring

Commit SHA for the "before" measurement (use with afterCommit)

afterCommitstring

Commit SHA for the "after" measurement (use with beforeCommit)

beforeRunIdstring

Test run ID for the "before" measurement (use with afterRunId)

afterRunIdstring

Test run ID for the "after" measurement (use with beforeRunId)

Response

Test comparison result

testNamestring required

Changes

No recorded changes to this operation across all 1 revision of this API.