For the complete documentation index, see llms.txt. This page is also available as Markdown.

Jobs

The job endpoint allows the scheduling of a job to extract data and fetch the results once complete. Jobs will protect you from hitting rate limits and will ensure a smoother data retrieval experience. This feature has been built into the ReportExport and ClickExport where a job is scheduled automatically for you when you use this endpoint.

Job runtime

The job runtime depends on the requested data and averages around 5 seconds. The job runs as follows:

  1. The job is Scheduled.

  2. The job is Queued to process. Jobs with large data set requests can wait in the queue and impact the execution time.

  3. The job will Run.

  4. The job Results become available for download.