client.jobs.get_history

Retrieve jobs history

client.jobs.get_history(self, user=None, access_key=None, start_date=None, end_date=None, model=None, status='all', sort_by=None, direction=None, page=None, per_page=None)

Retrieve the list of jobs by using the search parameters.

ParameterTypeDescriptionExample
userstrName of the job submitter'Sarah Connor'
access_keystrIdentifier of the access key'jU7q896uSReJcXXDOS6P'
start_datedatetime
str
Filters jobs by the start date. It requires ISO8601 format (YYYY-MM-DDThh:mm:ss.sTZD) format or to be a datetime object (https://docs.python.org/3/library/datetime.html).datetime.now()
'2021-08-13T07:28:30.831'
end_datedatetime
str
Filters jobs by the end date. It requires ISO8601 formated string (YYYY-MM-DDThh:mm:ss.sTZD) or a datetime object (https://docs.python.org/3/library/datetime.html).datetime.now()
'2021-08-13T07:28:30.831'
modelstrFilters by the model's name.'ed542963de'
statusstrFilters by the job status categories. Values can be: ALL, PENDING, TERMINATED. It can also filter by the job status: SUBMITTED, COMPLETED, CANCELED, IN_PROGRESS, TIMEDOUT, ERROR.'ALL'
sort_bystrCan be sorted by identifier, submittedBy, submittedJobs, status, createdAt, updatedAt, submitedAt, total, completed, fail and model.'model'
directionstrOrders the records in ascending (ASC) or descending (DESC) order. It defaults to ASC.'ASC'
pageintThe page number to be returned. Defaults to 0.1
per_pageintThe number of records returned per page. Defaults to 10.10

Returns

[
  {
    "job_identifier": "string",
    "status",
    "account_identifier": "string",        
    "explain": "boolean",        
    "created_at": "date-time",
    "updated_at": "date-time",
    "submitted_at": "date-time",
    "submitted_by": "string",        
    "pending": "integer",
    "completed": "integer",    
    "failed": "integer",
    "total": "integer",    
    "model": {
      "identifier": "string",
      "version": "string",
      "name": "string"
    },
    "job_inputs": ["string"],
    "user": {
      "identifier": "string",
      "external_identifier": "string",
      "email": "string",
      "firstName": "string",      
      "lastName": "string",
      "status": "string",
      "title": "string"
      "access_keys": [
      	{
      		"prefix": "string",
          "is_default": "boolean"
    		}
      ]                        
    }
  }
]

Examples

>>>job_history = client.jobs.get_history()
>>>len(job_history)
10