Skip to content
Overmind
Get started
API Reference
Job Iterations

List job iterations

job_iterations.list(JobIterationListParams**kwargs) -> JobIterationListResponse
GET/api/job-iterations/

List job iterations

ParametersExpand Collapse
iteration_name: Optional[str]
job: Optional[str]
formatuuid
ordering: Optional[str]

Which field to use when ordering the results.

page: Optional[int]

A page number within the paginated result set.

score_max: Optional[float]
formatfloat
score_min: Optional[float]
formatfloat
status: Optional[Literal["discard", "keep"]]
  • keep - Keep
  • discard - Discard
Accepts one of the following:
"discard"
"keep"
ReturnsExpand Collapse
class JobIterationListResponse: …
count: int
results: List[Result]
id: str
formatuuid
created_at: datetime
formatdate-time
iteration_name: str
maxLength64
job: str
formatuuid
agent_code: Optional[str]
avg_score: Optional[float]
formatdouble
description: Optional[str]
dimension_scores: Optional[object]
order: Optional[int]
maximum9223372036854776000
minimum-9223372036854776000
formatint64
status: Optional[Literal["keep", "discard"]]
  • keep - Keep
  • discard - Discard
Accepts one of the following:
"keep"
"discard"
List job iterations
from overmind_lab import OvermindLab

client = OvermindLab()
job_iterations = client.job_iterations.list()
print(job_iterations.count)
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "iteration_name": "iteration_name",
      "job": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "agent_code": "agent_code",
      "avg_score": 0,
      "description": "description",
      "dimension_scores": {},
      "order": -9007199254740991,
      "status": "keep"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}
Returns Examples
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "iteration_name": "iteration_name",
      "job": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "agent_code": "agent_code",
      "avg_score": 0,
      "description": "description",
      "dimension_scores": {},
      "order": -9007199254740991,
      "status": "keep"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}