Delete Search

4min

Delete Search
Searches can be deleted by making an  HTTP DELETE request to the  /batches/BATCH_ID/SEARCH_ID endpoint (where  SEARCH_ID is the  id of the Search to delete and  BATCH_ID is the  id of the Batch the Search belongs to).
Batch Status
Searches can only be deleted from a Batch when it is not running. To check whether a Batch is currently running use the Get Batch endpoint.
Deleting Multiple Searches
You should make calls to the Delete Search endpoint sequentially, rather than in parallel, as it is designed to remove Searches one by one. If you make too many concurrent calls you will receive an  HTTP 429  error. For mass-delete operations consider deleting and re-creating the Batch as this is typically quicker.
Alternatively if your use-case requires mass deletion of Searches you may make an  HTTP DELETE  request to the  /batches/BATCH_ID/searches  endpoint with the  Content-Type  HTTP header set to  application/json  and the body of the request being an array of Search ID strings. The platform will then delete each of the IDs specified.
﻿
Example
﻿DELETE  /batches/BATCH_ID/SEARCH_ID
In the example below we delete a Search with  id=ABCDEFGHIJKLMNOP from Batch with  id=123456 :
Curl
Node.js
Python
PHP
$ curl -X DELETE "https://api.valueserp.com/batches/123456/ABCDEFGHIJKLMNOP?api_key=demo"
$ curl -X DELETE "https://api.valueserp.com/batches/123456/ABCDEFGHIJKLMNOP?api_key=demo"
﻿
VALUE SERP responds with a JSON object confirming that the Search has been deleted, or detailing the error if it has not been possible to delete the Search:
✅Success JSON
❌No Search
❌No Batch
{
  "request_info": {
    "success": false,
    "message": "Batch with ID '123456' was not found"
  }
}
{
  "request_info": {
    "success": false,
    "message": "Batch with ID '123456' was not found"
  }
}
﻿
﻿
Next Steps
     Update Search
     List Search﻿

Updated 13 Aug 2024

Did this page help you?

Update Search

Clear Searches