SCscorecard-ai

Get Run

Changed on

Retrieve a specific Run by ID.

get/runs/{runId}

Request

  • Base URL
    https://api2.scorecard.io/api/v2
  • Auth
    HTTP bearer

Path parameters

runIdstring required
Example:135

The ID of the Run to retrieve.

Response

Successfully retrieved Run.

idstring required

The ID of the Run.

testsetIdstring nullable required

The ID of the Testset this Run is testing.

systemIdstring uuid nullable required

The ID of the system this Run is using.

systemVersionIdstring uuid nullable required

The ID of the system version this Run is using.

metricIdsstring[] required

The IDs of the metrics this Run is using.

metricVersionIdsstring[] required

The IDs of the metric versions this Run is using.

numRecordsnumber required

The number of records in the Run.

numExpectedRecordsnumber nullable required

The number of expected records in the Run. Determined by the number of testcases in the Run's Testset at the time of Run creation.

numScoresnumber required

The number of completed scores in the Run so far.

status'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed' required

The status of the Run.

Changes