Skip to main content
GET
/
v5
/
evaluation-groups
List Evaluation Groups
curl --request GET \
  --url https://api.egp.scale.com/v5/evaluation-groups \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "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"
        }
      ]
    }
  ],
  "total": 123,
  "has_more": true,
  "object": "list",
  "limit": 100
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Query Parameters

include_deleted
boolean
default:false
tags
string[] | null
name
string | null
evaluation_id
string | null

Filter to groups containing this evaluation ID

views
enum<string>[]

Optional relationships to include: 'members', 'row_identifiers'

Views for evaluation group responses

Available options:
members,
row_identifiers
starting_after
string | null
ending_before
string | null
limit
integer
default:100
Required range: 1 <= x <= 10000
sort_by
string | null
sort_order
enum<string> | null
default:asc
Available options:
asc,
desc

Response

Successful Response

items
Items · object[]
required
total
integer
required

The total of items that match the query. This is greater than or equal to the number of items returned.

has_more
boolean
required

Whether there are more items left to be fetched.

object
string
default:list
Allowed value: "list"
limit
integer
default:100

The maximum number of items to return.