Skip to content
sgp
API Reference
Evaluation Groups

Get Evaluation Group

client.evaluationGroups.retrieve(stringgroupID, EvaluationGroupRetrieveParams { include_deleted, views } query?, RequestOptionsoptions?): EvaluationGroup { id, account_id, created_at, 8 more }
GET/v5/evaluation-groups/{group_id}

Fetch a single evaluation group by its ID.

By default only non-archived groups are returned; set include_deleted to also resolve a soft-deleted group, whose response includes its soft-deleted member rows.

members is always returned, so a client can confirm membership without passing a view, and views adds further expansions on top (e.g. views=row_identifiers). The full member set is returned with no cap, and each member is enriched with its evaluation’s name, tags, and creation time where that evaluation is readable from this account; those fields are null otherwise. Use the schema endpoint instead when you need the per-evaluation column schemas of the group’s members.

ParametersExpand Collapse
groupID: string
query: EvaluationGroupRetrieveParams { include_deleted, views }
include_deleted?: boolean
views?: Array<EvaluationGroupViews>

Additional relationships to include; ‘members’ is always returned

One of the following:
"members"
"row_identifiers"
ReturnsExpand Collapse
EvaluationGroup { 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<string> | null

The tags associated with the entity

deleted_at?: string

When the group was soft-deleted

formatdate-time
description?: string

Optional description

members?: Array<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?: string

When this membership was soft-deleted (if applicable)

formatdate-time
evaluation_created_at?: string

When the evaluation was created

formatdate-time
evaluation_name?: string

Name of the evaluation

evaluation_tags?: Array<string>

Tags of the evaluation

object?: "evaluation_group.member"
metadata?: Record<string, unknown>

Optional metadata key-value pairs

object?: "evaluation_group"
row_identifiers?: Array<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?: "evaluation_group.row_identifier"

Get Evaluation Group

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const evaluationGroup = await client.evaluationGroups.retrieve('group_id');

console.log(evaluationGroup.id);
{
  "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"
    }
  ]
}