Sign in
latestOpenAPI 3.0.32026-08-08360156.4 KB

ae7fddf16bf9

Intellimatch

Get export status

Poll this endpoint to check if a given search is completed.

The response will contain a status field with one of the following values:

  • success: Export is completed and ready to download
  • processing: Export is currently being processed (includes progress information)
  • pending: Export is queued but not yet started
  • failed: Export has failed
  • not_found: Export hash not found or expired
get/api/intellimatch/status

Query parameters

hashstring required

The export hash returned by the search endpoint.

Example:74ebbec924a9666053d234eecc685a1d73c699d1

The export hash returned by the search endpoint.

Response

Export processing

statusstring

The current status of the export.

progressinteger

The progress percentage (only when status is "processing").

total_jobsinteger

Total number of jobs (only when status is "processing").

processed_jobsinteger

Number of processed jobs (only when status is "processing").

pending_jobsinteger

Number of pending jobs (only when status is "processing").

failed_jobsinteger

Number of failed jobs (only when status is "processing").

Example response

{
  "status": "processing",
  "progress": 45,
  "total_jobs": 100,
  "processed_jobs": 45,
  "pending_jobs": 55,
  "failed_jobs": 0
}