Skip to main content
GET
/
projects
/
{projectId}
/
runs
JavaScript
import Scorecard from 'scorecard-ai';

const client = new Scorecard({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const run of client.runs.list('314')) {
  console.log(run.id);
}
{
  "data": [
    {
      "id": "135",
      "testsetId": "246",
      "systemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "systemVersionId": "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0",
      "metricIds": [
        "789",
        "101"
      ],
      "metricVersionIds": [
        "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0",
        "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf1"
      ],
      "numRecords": 10,
      "numExpectedRecords": 10,
      "numScores": 20,
      "status": "completed"
    },
    {
      "id": "136",
      "testsetId": null,
      "systemId": null,
      "systemVersionId": null,
      "metricIds": [
        "789"
      ],
      "metricVersionIds": [
        "87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0"
      ],
      "numRecords": 5,
      "numExpectedRecords": null,
      "numScores": 3,
      "status": "running_scoring"
    }
  ],
  "nextCursor": "8fb15f74-2918-4982-a4fc-9c157f77dca8",
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
projectId
string
required

The ID of the Run's Project.

Example:

"314"

Query Parameters

​
limit
integer
default:20

Maximum number of items to return (1-100). Use with cursor for pagination through large sets.

Example:

20

​
cursor
string

Cursor for pagination. Pass the nextCursor from the previous response to get the next page of results.

Example:

"123"

Response

Successfully retrieved list of runs.

​
data
object[]
required
​
nextCursor
string | null
required
​
hasMore
boolean
required
​
total
integer
Required range: x >= 0