Skip to content
sgp
API Reference

Evaluation Groups

Create Evaluation Group
client.EvaluationGroups.New(ctx, body) (*EvaluationGroup, error)
POST/v5/evaluation-groups
List Evaluation Groups
client.EvaluationGroups.List(ctx, query) (*CursorPage[EvaluationGroup], error)
GET/v5/evaluation-groups
Get Evaluation Group
client.EvaluationGroups.Get(ctx, groupID, query) (*EvaluationGroup, error)
GET/v5/evaluation-groups/{group_id}
Patch Evaluation Group
client.EvaluationGroups.Update(ctx, groupID, body) (*EvaluationGroup, error)
PATCH/v5/evaluation-groups/{group_id}
Update Evaluation Group
client.EvaluationGroups.Replace(ctx, groupID, body) (*EvaluationGroup, error)
PUT/v5/evaluation-groups/{group_id}
Archive Evaluation Group
client.EvaluationGroups.Archive(ctx, groupID) (*EvaluationGroup, error)
DELETE/v5/evaluation-groups/{group_id}
Get Evaluation Group Schema
client.EvaluationGroups.GetSchema(ctx, groupID, query) (*EvaluationGroupGetSchemaResponse, error)
GET/v5/evaluation-groups/{group_id}/schema
ModelsExpand 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
type EvaluationGroupMember struct{…}

Response model for evaluation group member

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
type EvaluationGroupRowIdentifier struct{…}

Response model for evaluation group row identifier

ColumnName string

Name of the column used as row identifier

EvaluationID string

ID of the evaluation

Object EvaluationGroupRowIdentifierObjectOptional
type EvaluationGroupViews string

Views for evaluation group responses

One of the following:
const EvaluationGroupViewsMembers EvaluationGroupViews = "members"
const EvaluationGroupViewsRowIdentifiers EvaluationGroupViews = "row_identifiers"