Batches
...
Batches API
Batches

Start Batch

3min

Start Batch

Batches can be started by making an HTTP GET request to the /batches/BATCH_ID/start endpoint (where BATCH_ID is the id of the Batch). You must have sufficient search credits available on your account for the number of searches in the Batch.

You would typically start Batches that are set to schedule_type=manual but you can start a Batch with any schedule_type , just as long as it isn't currently running.



Example

GET /batches/BATCH_ID/start

In the example below we start a Batch with id=123456 :

HTTP
Curl
Node.js
Python
PHP


VALUE SERP responds with a JSON object confirming that the Batch has been started, or detailing the error if it has not been possible to start the Batch (i.e. there are insufficient search credits available on your account).



Next Steps      Get Batches      List Batches

Updated 13 Aug 2024
Did this page help you?