Deferred Response Overview

Deferred response is a term used to refer to endpoints like ClickExports and ReportExports that take the parameters you provide, and allow you to schedule tasks to receive data at a future time.

The response from the API is thus deferred, unlike the synchronous versions of the endpoints (Clicks and Reports respectively), which will give a response right away.

Replaying a job

An existing job can be added to the queue to be processed again.

⚠️

Note:

If you don't provide an end date for your report, each time the job runs, the report will contain data up until the current date. The amount of information being reported on can thus change each time the job is replayed.

Creating a job

  • The POST method is an INSERT action, so if no job exists, the new job will be created. However, if one already exists, an error will be returned.

  • The PUT method is an UPSERT action, so if no job exists, the new job will be created. If one does already exist, the existing job will be replayed. The PUT method thus saves you from needing to manually call the /Replay endpoint from the /Jobs API.