Documentation | Evaluation Groups › List Evaluation Groups

Evaluation Groups

evaluation_groups

Methods

Create Evaluation Group ->

EvaluationGroup

post/v5/evaluation-groups

Create a new evaluation group

List Evaluation Groups -> CursorPage<

EvaluationGroup

get/v5/evaluation-groups

List all evaluation groups for the current account

query Parameters

ending_before: string

Optional

evaluation_id: string

Optional

Filter to groups containing this evaluation ID

include_deleted: boolean

Optional

limit: number

Optional

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

name: string

Optional

sort_by: string

Optional

sort_order:

SortOrder

Optional

starting_after: string

Optional

tags: Array<string>

Optional

views: Array<

EvaluationGroupViews

Optional

(default: [])

Optional relationships to include: 'members', 'row_identifiers'

"members"

"row_identifiers"

EvaluationGroupViews

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

EvaluationGroup

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-groups \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "tags": [
        "string"
      ],
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "members": [
        {
          "id": "id",
          "created_at": "2019-12-27T18:11:19.117Z",
          "evaluation_group_id": "evaluation_group_id",
          "evaluation_id": "evaluation_id",
          "deleted_at": "2019-12-27T18:11:19.117Z",
          "evaluation_created_at": "2019-12-27T18:11:19.117Z",
          "evaluation_name": "evaluation_name",
          "evaluation_tags": [
            "string"
          ],
          "object": "evaluation_group.member"
        }
      ],
      "metadata": {
        "foo": "bar"
      },
      "object": "evaluation_group",
      "row_identifiers": [
        {
          "column_name": "column_name",
          "evaluation_id": "evaluation_id",
          "object": "evaluation_group.row_identifier"
        }
      ]
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Get Evaluation Group ->

EvaluationGroup

get/v5/evaluation-groups/{group_id}

Get a single evaluation group by ID

Patch Evaluation Group ->

EvaluationGroup

patch/v5/evaluation-groups/{group_id}

Partial update of evaluation group attributes (name, description, tags, metadata). Members cannot be modified via PATCH.

Update Evaluation Group ->

EvaluationGroup

put/v5/evaluation-groups/{group_id}

Full update of evaluation group. All fields are replaced with provided values. Omitted optional fields are cleared.

Archive Evaluation Group ->

EvaluationGroup

delete/v5/evaluation-groups/{group_id}

Soft-delete an evaluation group and cascade to members, row identifiers, and charts

Get Evaluation Group Schema -> { evaluation_group_id, evaluation_schemas, object }

get/v5/evaluation-groups/{group_id}/schema

Get per-evaluation schemas for all members of a group. Returns individual schema for each member evaluation, enabling the frontend to filter columns by selected eval subset.

Domain types

EvaluationGroup = { id, account_id, created_at, 8 more... }

Response model for evaluation group

EvaluationGroupMember = { id, created_at, evaluation_group_id, 6 more... }

Response model for evaluation group member

EvaluationGroupRetrieveSchemaResponse = { evaluation_group_id, evaluation_schemas, object }

Per-evaluation schemas for all members of an evaluation group

EvaluationGroupRowIdentifier = { column_name, evaluation_id, object }

Response model for evaluation group row identifier

EvaluationGroupViews = "members" | "row_identifiers"

Views for evaluation group responses