Theme switcher

List Jobs

Job Listing: Retrieve a comprehensive list of your background jobs with advanced filtering and sorting.

Status Values

Attribute

Type

Description

queued

string

Job created and waiting for processing resources

running

string

Data extraction in progress

completed

string

Job finished successfully and download URL available

failed

string

Error occurred during processing

cancelled

string

Job cancelled by user or timeout

Response Fields

Attribute

Type

Description

job_id

string

Unique job identifier for tracking and reference

procedure_name

string

Name of the data extraction procedure

status

string

Current job status

progress_percent

number

Completion percentage from 0 to 100

rows_processed

integer

Current number of records processed

estimated_rows

integer

Estimated total number of rows to process

estimated_completion_seconds

integer

Estimated time to completion in seconds

created_at

date-time

Job creation timestamp

started_at

date-time

Job processing start timestamp

completed_at

date-time

Job completion timestamp

execution_time_seconds

number

Total processing time in seconds

file_size_bytes

integer

Size of generated output file in bytes

output_format

string

Requested output format

compression

string

Applied compression type

s3_url

string

Secure download URL

expires_at

date-time

Download URL expiry timestamp

error_message

string

Error information

retry_count

integer

Number of automatic retry attempts

Use Cases:

  • Monitor job progress and status
  • Retrieve download URLs for completed jobs
  • Track job performance and execution times
  • Manage job queues and priorities
  • Audit job history and usage patterns

Query Parameters

limitstring

Maximum number of jobs to return (1-200)

statusstring

Filter by job status: queued, running, completed, failed, cancelled. (null = no filter)

Path Parameters

{customer_id}string Required

Unique customer identifier

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1
Was this section helpful?

What made this section unhelpful for you?