Skip to main content
GET
List evaluations

Authorizations

Authorization
string
header
required

Use a key created in the Playground. Keys begin with gk_.

Query Parameters

limit
integer
default:20

Maximum evaluations to return.

Required range: 1 <= x <= 100
offset
integer
default:0

How many to skip before the page starts. With limit this addresses a page directly -- limit=20&offset=40 is the third page. The 100-item limit bounds one response, not what exists: a caller asking for 500 gets 100, and the hundred-and-first evaluation is one more request away rather than unreachable.

Required range: x >= 0
video_id
string

Return evaluations for one stored video.

status
enum<string>[]

Keep only these statuses. Comma-joined (?status=failed,partial) or repeated (?status=failed&status=partial); both are accepted. Filtered before paging, so counts and the page boundaries describe the same filtered set. An unrecognised value is dropped rather than refused -- a stale bookmark should return an empty list, not an error.

Available options:
queued,
processing,
completed,
partial,
failed

Response

Evaluation list.

object
string
required
Allowed value: "list"
data
object[]
required
counts
object

How many evaluations exist in each status, over the same owner and video scope as the request and deliberately IGNORING limit, offset and status. This is what a pager needs. Inferring the end of a list from "was the page full" is wrong at exactly the boundary paging exists to make honest, and a bare total could not tell you the page count for a filtered view.