JSON API
Job Tracking
4min
overview the indexing job tracking api is designed to monitor and manage the progress of jobs related to batch processing these apis allow users to track the status of jobs as they move through different stages done, processing, and initializing key features of the api include job status retrieve the current state of the job, helping to understand whether a job is completed (done), still in progress (processing), or just beginning (initializing) timestamps access each job's start and end times, providing a timeline for tracking the job's execution duration document management manage documents involved in the job, including docs in request the documents submitted in the job request docs affected documents that are impacted due to operations like inheritance, category updates docs completed track the document ids of those that have successfully completed processing schema (response) { 	"apikey" "klevu xxxxxxxxxxxxxxx", 	"jobid" "890709879342", 	"docsinrequest" \["cat1"], 	"docsaffected" \[ "product1", "product2", ], 	"docscompleted \[ "product1", ], 	"status" "initializing/processing/done", 	"jobtype" "batch index/batch index partial save/batch index delete/channel delete/channel update", 	"starttime" "2023 08 24t10 10 10 100z", 	"endtime" "023 08 24t10 10 10 100z" } understanding the response parameters apikey this is the store's js api key it can be obtained using link jobid the unique id represents an individual job docsinrequest originally received document id as part of user actions docsaffected all the document id which is going to be affected by user action eg if we are updating the category name and it will affect 20 documents that is attached to that category, the service will get those 20 document ids as affected documents docscompleted all document ids that are successfully cleared from the processing jobtype indicates the type of job submitted status the status of the job, at the moment, we support three statuses here are the details initializing the job was accepted and is queued for processing processing job is progressing through the system and search is getting updated done job is complete and all affected documents are updated on search starttime the timestamp when the job was initiated endtime when status is changed to done, the system will use the timestamp to set this attribute in schema, it will determine at which time all documents were completed from the job api specifications please refer to job tracking section of swagger/openapi specification docid\ w5ivv5q4jjbffywxds5p8