Create Evaluation Group

POST/v5/evaluation-groups

Create a new evaluation group bundling one or more existing evaluations.

The request must list at least one evaluation ID, and duplicate IDs are rejected. Every listed evaluation is validated for existence and account access before the group is created; an unknown or inaccessible evaluation ID fails the whole request with a 400 rather than creating a partial group. The named evaluations are added as group members in the same transaction, and any supplied row_identifiers (an evaluation_id-to-column-name mapping used for cross-dataset joins) are persisted alongside them, ignoring entries for evaluation IDs not in the group. The returned group includes its members enriched with each evaluation’s name, tags, and creation time. Unlike the PUT and PATCH update endpoints, creation does not trigger any dashboard-widget recomputation.

Body ParametersJSONExpand Collapse

evaluation_ids: array of string

List of evaluation IDs to include in the group

name: string

Name of the evaluation group

maxLength128

description: optional string

Optional description

metadata: optional map[unknown]

Optional metadata key-value pairs

row_identifiers: optional map[string]

Optional mapping of evaluation_id to column name for cross-dataset joins

tags: optional array of string

The tags associated with the entity

ReturnsExpand Collapse

EvaluationGroup object { id, account_id, created_at, 8 more }

Response model for evaluation group

id: string

Unique identifier of the evaluation group

account_id: string

Account that owns this evaluation group

created_at: string

When the group was created

formatdate-time

name: string

Name of the evaluation group

tags: array of string

The tags associated with the entity

deleted_at: optional string

When the group was soft-deleted

formatdate-time

description: optional string

Optional description

members: optional array of EvaluationGroupMember { id, created_at, evaluation_group_id, 6 more }

Evaluation members in this group. Returned by default on GET by id; on list endpoints, populated only with the ‘members’ view.

id: string

Unique identifier of the member record

created_at: string

When this member was added to the group

formatdate-time

evaluation_group_id: string

ID of the evaluation group

evaluation_id: string

ID of the evaluation

deleted_at: optional string

When this membership was soft-deleted (if applicable)

formatdate-time

evaluation_created_at: optional string

When the evaluation was created

formatdate-time

evaluation_name: optional string

Name of the evaluation

evaluation_tags: optional array of string

Tags of the evaluation

object: optional "evaluation_group.member"

metadata: optional map[unknown]

Optional metadata key-value pairs

object: optional "evaluation_group"

row_identifiers: optional array of EvaluationGroupRowIdentifier { column_name, evaluation_id, object }

Row identifier mappings. Populated with ‘row_identifiers’ view.

column_name: string

Name of the column used as row identifier

evaluation_id: string

ID of the evaluation

object: optional "evaluation_group.row_identifier"

Create Evaluation Group

curl https://api.egp.scale.com/v5/evaluation-groups \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
          "evaluation_ids": [
            "string"
          ],
          "name": "name",
          "metadata": {
            "project": "bar",
            "team": "bar"
          },
          "row_identifiers": {
            "eval-123": "user_id",
            "eval-456": "customer_id"
          }
        }'

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

Returns Examples

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