List Evaluation Groups

client.EvaluationGroups.List(ctx, query) (*CursorPage[EvaluationGroup], error)

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

query EvaluationGroupListParams

EndingBefore param.Field[string]Optional

EvaluationID param.Field[string]Optional

Filter to groups containing this evaluation ID

IncludeDeleted param.Field[bool]Optional

Limit param.Field[int64]Optional

maximum10000

minimum1

Name param.Field[string]Optional

SortBy param.Field[string]Optional

SortOrder param.Field[SortOrder]Optional

StartingAfter param.Field[string]Optional

Tags param.Field[[]string]Optional

Views param.Field[[]EvaluationGroupViews]Optional

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

const EvaluationGroupViewsMembers EvaluationGroupViews = "members"

const EvaluationGroupViewsRowIdentifiers EvaluationGroupViews = "row_identifiers"

ReturnsExpand Collapse

type EvaluationGroup struct{…}

Response model for evaluation group

ID string

Unique identifier of the evaluation group

AccountID string

Account that owns this evaluation group

CreatedAt Time

When the group was created

formatdate-time

Name string

Name of the evaluation group

Tags []string

The tags associated with the entity

DeletedAt TimeOptional

When the group was soft-deleted

formatdate-time

Description stringOptional

Optional description

Members []EvaluationGroupMemberOptional

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

CreatedAt Time

When this member was added to the group

formatdate-time

EvaluationGroupID string

ID of the evaluation group

EvaluationID string

ID of the evaluation

DeletedAt TimeOptional

When this membership was soft-deleted (if applicable)

formatdate-time

EvaluationCreatedAt TimeOptional

When the evaluation was created

formatdate-time

EvaluationName stringOptional

Name of the evaluation

EvaluationTags []stringOptional

Tags of the evaluation

Object EvaluationGroupMemberObjectOptional

Metadata map[string, any]Optional

Optional metadata key-value pairs

Object EvaluationGroupObjectOptional

RowIdentifiers []EvaluationGroupRowIdentifierOptional

Row identifier mappings. Populated with ‘row_identifiers’ view.

ColumnName string

Name of the column used as row identifier

EvaluationID string

ID of the evaluation

Object EvaluationGroupRowIdentifierObjectOptional

List Evaluation Groups

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  page, err := client.EvaluationGroups.List(context.TODO(), sgpdev.EvaluationGroupListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

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