Get Evaluation Group 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.

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

Get Evaluation Group Schema

cURL

curl --request GET \
  --url https://api.egp.scale.com/v5/evaluation-groups/{group_id}/schema \
  --header 'x-api-key: <api-key>'

200

{
  "evaluation_group_id": "<string>",
  "evaluation_schemas": [
    {
      "evaluation_id": "<string>",
      "total_items": 1,
      "fields": [
        {
          "field_name": "<string>",
          "data_type": "<string>",
          "item_count": 1,
          "object": "field_schema"
        }
      ],
      "object": "evaluation_schema",
      "is_sampled": false,
      "sample_size": 1
    }
  ],
  "object": "evaluation_group_schema"
}

Authorizations

x-api-key · string · header · required

Headers

x-selected-account-id · string | null

Path Parameters

group_id · string · required

Query Parameters

include_archived · boolean · default: false

Include archived items in schema analysis

Response

200

application/json

Successful Response

Per-evaluation schemas for all members of an evaluation group

evaluation_group_id · string · required

The ID of the evaluation group

evaluation_schemas · Evaluation Schemas · object[] · required

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

Show child attributes

object · string · default: evaluation_group_schema

Allowed value: "evaluation_group_schema"