Skip to main content
GET
/
evaluations
{
  "jobs": [
    {
      "job_id": "<string>",
      "status": "<string>",
      "total_items": 123,
      "processed_items": 123,
      "failed_items": 123,
      "progress_percentage": 123,
      "judge_id": "<string>",
      "judge_name": "<string>",
      "created_at": {},
      "started_at": {},
      "completed_at": {},
      "estimated_completion_time": {},
      "priority": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "limit": 123,
    "offset": 123,
    "has_next": true,
    "has_previous": true
  }
}

Overview

Retrieves a list of evaluation jobs submitted by your organization using API key authentication. Supports filtering, sorting, and pagination for efficient job management.

Headers

X-API-Key
string
required
Organization API key for authentication

Query Parameters

status
string
Filter jobs by status
  • queued - Jobs waiting to be processed
  • processing - Jobs currently being processed
  • completed - Successfully completed jobs
  • failed - Failed jobs
  • cancelled - Cancelled jobs
judge_id
string
Filter jobs by judge ID
created_after
datetime
Filter jobs created after this timestamp (ISO 8601)
created_before
datetime
Filter jobs created before this timestamp (ISO 8601)
limit
integer
default:"25"
Maximum number of jobs to return
offset
integer
default:"0"
Number of jobs to skip for pagination
sort_by
string
default:"created_at"
Field to sort results by
  • created_at - Creation timestamp
  • completed_at - Completion timestamp
  • progress_percentage - Job progress
  • total_items - Number of items in job
sort_order
string
default:"desc"
Sort order
  • asc - Ascending order
  • desc - Descending order

Response

jobs
array
required
List of evaluation jobs
pagination
object
required
Pagination information

Examples

curl -X GET "https://api.judge.example.com/evaluations?limit=10&sort_by=created_at&sort_order=desc" \
  -H "X-API-Key: YOUR_API_KEY"
curl -X GET "https://api.judge.example.com/evaluations?status=failed&created_after=2024-01-14T00:00:00Z" \
  -H "X-API-Key: YOUR_API_KEY"
curl -X GET "https://api.judge.example.com/evaluations?created_after=invalid-date" \
  -H "X-API-Key: YOUR_API_KEY"