Skip to content

List criterion versions

rubrics.criteria.list_versions(strrubric_criteria_id, CriterionListVersionsParams**kwargs) -> CriterionListVersionsResponse
GET/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions

List the full version history of a single criterion, paginated.

Because criterion updates are append-only, this returns one entry per version, exposing every prior state of the criterion, ordered by version descending (newest first) by default. The request is rejected if the criterion does not belong to the rubric named in the path.

ParametersExpand Collapse
rubric_id: str
rubric_criteria_id: str
ending_before: Optional[str]
limit: Optional[int]
maximum10000
minimum1
sort_by: Optional[str]
sort_order: Optional[SortOrder]
One of the following:
"asc"
"desc"
starting_after: Optional[str]
ReturnsExpand Collapse
class CriterionListVersionsResponse: …
has_more: bool

Whether there are more items left to be fetched.

id: str
created_at: datetime
formatdate-time
rubric_id: str
title: str
version: int
annotations: Optional[Dict[str, object]]
object: Optional[Literal["rubric_criteria"]]
weight: Optional[float]
total: int

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

limit: Optional[int]

The maximum number of items to return.

object: Optional[Literal["list"]]

List criterion versions

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
)
response = client.rubrics.criteria.list_versions(
    rubric_criteria_id="rubric_criteria_id",
    rubric_id="rubric_id",
)
print(response.has_more)
{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "rubric_id": "rubric_id",
      "title": "title",
      "version": 0,
      "annotations": {
        "foo": "bar"
      },
      "object": "rubric_criteria",
      "weight": 0
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}
Returns Examples
{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "rubric_id": "rubric_id",
      "title": "title",
      "version": 0,
      "annotations": {
        "foo": "bar"
      },
      "object": "rubric_criteria",
      "weight": 0
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}