Scheduling Requests

Schedule API requests on a periodic basis. Once you launch a scheduler, we will run API requests on a period basis.

If you run out of storage or credits while a scheduler is running, we will notify you via email that a request has failed.

How to set up automatic/scheduled queries

You can find automatic queries under the Automate tab.

First, you need to pick the settings for your scheduler, including frequency, rule, and run on launch.

Scheduler settings

Frequency

Allows you to select how often you'd like to run the request. You can set requests to run every week, day, hour, or minute. You can also click the Cron option in the drop-down to customize schedulers to run at specific hours or times.

Rule

Allows you to select what happens after every API call:

• Update dataset will erase what's currently in the table and replace it with new data.

• Expand dataset will add new data to existing data in the table.

Run on launch

If selected, we will run your query when you save the scheduler. If you uncheck this box, we will only run this query on your next scheduled request.

Setting up parameters

After picking the settings, the parameters work the same as a normal request. To set up the scheduler, enter the settings described above, enter parameters, and click Save & Run.

Dynamic dates

If you want to change the input parameters for every scheduled run, you can set dynamic dates & times to pass into your request. To set them up, under the Automate tab, you'll see a checkbox make dynamic. Once checked, the date/time parameters will adjust every time the scheduler is run. You can pass a now() value to make the date/time parameter equal to the date/time of the request or set it to -1/2/3 days.

You cannot submit single queries or run batch requests while a scheduler runs on a dataset. You must pause your scheduler to run single queries and batch requests.