Documentation | Evaluation Items › List And Filter Evaluation Items

Evaluation Items

evaluation_items

Methods

Get A Single Evaluation Item ->

get/v5/evaluation-items/{evaluation_item_id}

Retrieve a single evaluation item by its ID within the caller's account.

By default only non-archived items are returned; pass include_archived=true to also retrieve an item that has been archived. The response merges the item's cached task results into its data field and exposes a task_errors map keyed by task alias, so a task that failed on this item surfaces as an entry there rather than as a request error. Use this to inspect one item's input data and per-task results; to page through many items, use the list endpoint instead. The request fails if no item with the given ID exists in the caller's account.

List And Filter Evaluation Items -> CursorPage<

EvaluationItem

get/v5/evaluation-items

Return a paginated list of evaluation items belonging to the caller's account.

Pass evaluation_id to restrict the results to a single evaluation's items. The completion_status filter selects items by whether any of their tasks errored: failed returns only items that have task errors, passed returns only items with no task errors, and all (or omitting the parameter) returns every item. Archived items are excluded unless include_archived=true. Each returned item has its cached task results merged into data and its errors exposed in task_errors, identically to the single-item endpoint.

query Parameters

completion_status:

Optional

Filter items by completion status. Pass 'failed' to return only items with errors, 'passed' for items without errors. Pass 'all' or omit to return all items.

"failed"

"passed"

"all"

ending_before: string

Optional

evaluation_id: string

Optional

include_archived: boolean

Optional

limit: number

Optional

(maximum: 10000, minimum: 1, default: 100)

sort_by: string

Optional

sort_order:

SortOrder

Optional

starting_after: string

Optional

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

EvaluationItem

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

curl https://api.egp.scale.com/v5/evaluation-items \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "data": {
        "foo": "bar"
      },
      "evaluation_id": "evaluation_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "dataset_item_id": "dataset_item_id",
      "dataset_item_version_num": 0,
      "files": {
        "foo": "string"
      },
      "object": "evaluation.item",
      "task_errors": {
        "foo": {
          "message": "message",
          "type": "type"
        }
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Export Evaluation Items To A File ->

EvaluationItemExport

post/v5/evaluation-items/export

Export all evaluation items for a single evaluation as a downloadable file.

The evaluation is specified by evaluation_id in the request body. export_format selects CSV, JSON, or JSONL; for CSV the per-item data and files fields are flattened into individual columns and metric-like result columns are expanded. export_method controls delivery: direct returns the file contents inline in the response, while signed_url uploads the file to object storage and returns a pre-signed download URL. Requesting signed_url in an environment where object storage is not configured fails with a 501, so use direct there instead. Set include_archived=true to include archived items in the export. This endpoint reads items only and does not modify the evaluation.

Domain types

Component = { data, label }

Container = { children, direction }

EvaluationItem = { id, created_at, created_by, 8 more... }

EvaluationItemExport = { filename, content, signed_url }

Response model for exporting evaluation items. This class represents the response when users export evaluation items. It contains either a signed URL to download the exported data from object storage, or the actual content bytes when direct download is used (in environments where object storage is not configured).

ExportFormat = "json" | "jsonl" | "csv"

ExportMethod = "signed_url" | "direct"

TaskError = { message, type }