Archive Evaluation Group

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

{
  "id": "<string>",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "object": "evaluation_group",
  "description": "<string>",
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "members": [
    {
      "id": "<string>",
      "evaluation_group_id": "<string>",
      "evaluation_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "object": "evaluation_group.member",
      "evaluation_name": "<string>",
      "evaluation_tags": [
        "<string>"
      ],
      "evaluation_created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "row_identifiers": [
    {
      "evaluation_id": "<string>",
      "column_name": "<string>",
      "object": "evaluation_group.row_identifier"
    }
  ]
}

Evaluation Groups

Archive Evaluation Group

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.

DELETE

evaluation-groups

{group_id}

Archive Evaluation Group

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

{
  "id": "<string>",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "object": "evaluation_group",
  "description": "<string>",
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "members": [
    {
      "id": "<string>",
      "evaluation_group_id": "<string>",
      "evaluation_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "object": "evaluation_group.member",
      "evaluation_name": "<string>",
      "evaluation_tags": [
        "<string>"
      ],
      "evaluation_created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "row_identifiers": [
    {
      "evaluation_id": "<string>",
      "column_name": "<string>",
      "object": "evaluation_group.row_identifier"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Headers

x-selected-account-id

string | null

Path Parameters

group_id

string

required

Response

Successful Response

Response model for evaluation group

string

required

Unique identifier of the evaluation group