Documentation | Evaluation Groups › Get Evaluation Group Schema

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

Get Evaluation Group ->

EvaluationGroup

get/v5/evaluation-groups/{group_id}

Get a single evaluation group by ID

path Parameters

group_id: string

query Parameters

include_deleted: boolean

Optional

views: Array<

EvaluationGroupViews

Optional

(default: [])

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

"members"

"row_identifiers"

EvaluationGroupViews

Response fields

EvaluationGroup

Request example

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

200Example

{
  "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"
    }
  ]
}

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.

path Parameters

group_id: string

query Parameters

include_archived: boolean

Optional

Include archived items in schema analysis

Response fields

evaluation_group_id: string

The ID of the evaluation group

evaluation_schemas: Array<

EvaluationSchemaResponse

Schema for each member evaluation in the group, one entry per active evaluation

object: "evaluation_group_schema"

Optional

(default: "evaluation_group_schema")

Request example

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

200Example

{
  "evaluation_group_id": "evaluation_group_id",
  "evaluation_schemas": [
    {
      "evaluation_id": "evaluation_id",
      "fields": [
        {
          "data_type": "data_type",
          "field_name": "field_name",
          "item_count": 0,
          "source": "data",
          "object": "field_schema"
        }
      ],
      "total_items": 0,
      "is_sampled": true,
      "object": "evaluation_schema",
      "sample_size": 0
    }
  ],
  "object": "evaluation_group_schema"
}

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