Skip to content
sgp
API Reference
Evaluation Groups

List Evaluation Groups

evaluation_groups.list(EvaluationGroupListParams**kwargs) -> SyncCursorPage[EvaluationGroup]
GET/v5/evaluation-groups

List the calling account’s evaluation groups with optional filters.

Results are paginated and scoped to the authenticated account. The optional filters combine with AND semantics: name does a case-insensitive partial (substring) match on the group name, tags returns only groups whose tag list contains all of the supplied tags, and evaluation_id returns only groups that have the given evaluation as an active member. By default archived (soft-deleted) groups are excluded; set include_deleted to include them. The views parameter optionally expands each group with its members and/or row_identifiers, and returned members are enriched with each evaluation’s name, tags, and creation time.

ParametersExpand Collapse
ending_before: Optional[str]
evaluation_id: Optional[str]

Filter to groups containing this evaluation ID

include_deleted: Optional[bool]
limit: Optional[int]
maximum10000
minimum1
name: Optional[str]
sort_by: Optional[str]
sort_order: Optional[SortOrder]
One of the following:
"asc"
"desc"
starting_after: Optional[str]
tags: Optional[Sequence[str]]
views: Optional[List[EvaluationGroupViews]]

Optional relationships to include: ‘members’, ‘row_identifiers’

One of the following:
"members"
"row_identifiers"
ReturnsExpand Collapse
class EvaluationGroup: …

Response model for evaluation group

id: str

Unique identifier of the evaluation group

account_id: str

Account that owns this evaluation group

created_at: datetime

When the group was created

formatdate-time
name: str

Name of the evaluation group

tags: Optional[List[str]]

The tags associated with the entity

deleted_at: Optional[datetime]

When the group was soft-deleted

formatdate-time
description: Optional[str]

Optional description

members: Optional[List[EvaluationGroupMember]]

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

id: str

Unique identifier of the member record

created_at: datetime

When this member was added to the group

formatdate-time
evaluation_group_id: str

ID of the evaluation group

evaluation_id: str

ID of the evaluation

deleted_at: Optional[datetime]

When this membership was soft-deleted (if applicable)

formatdate-time
evaluation_created_at: Optional[datetime]

When the evaluation was created

formatdate-time
evaluation_name: Optional[str]

Name of the evaluation

evaluation_tags: Optional[List[str]]

Tags of the evaluation

object: Optional[Literal["evaluation_group.member"]]
metadata: Optional[Dict[str, object]]

Optional metadata key-value pairs

object: Optional[Literal["evaluation_group"]]
row_identifiers: Optional[List[EvaluationGroupRowIdentifier]]

Row identifier mappings. Populated with ‘row_identifiers’ view.

column_name: str

Name of the column used as row identifier

evaluation_id: str

ID of the evaluation

object: Optional[Literal["evaluation_group.row_identifier"]]

List Evaluation Groups

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
page = client.evaluation_groups.list()
page = page.items[0]
print(page.id)
{
  "has_more": true,
  "items": [
    {
      "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"
        }
      ]
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}
Returns Examples
{
  "has_more": true,
  "items": [
    {
      "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"
        }
      ]
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}