Skip to content
sgp
API Reference
Evaluation Groups

Archive Evaluation Group

DELETE/v5/evaluation-groups/{group_id}

Archive (soft-delete) an evaluation group and its dependent records.

This is a soft delete: the group is marked deleted rather than removed, so it no longer appears in default list/get results but can still be fetched with the include-deleted flags. The same delete timestamp cascades as a soft delete to the group’s members, row identifiers, and its dashboard charts and their chart columns; the member evaluations themselves are not affected. The archived group is returned in the response.

Path ParametersExpand Collapse
group_id: string
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"

Archive Evaluation Group

curl https://api.egp.scale.com/v5/evaluation-groups/$GROUP_ID \
    -X DELETE \
    -H "x-api-key: $SGP_API_KEY"
{
  "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"
    }
  ]
}