Get Batch

4min

Get Batch
You can get a Batch by making making a HTTP GET request to the /batches/BATCH_ID endpoint (where BATCH_ID is the id of the Batch you wish to get).
VALUE SERP will return all information about the Batch, including whether it is currently running and how many Searches and Results Sets the Batch currently has.
Note that the Batch Get endpoint just returns counts of the number of Searches and Result Sets the Batch contains. If you wish to retrieve the actual Searches or Result Sets in the Batch you should use the List Searches and List Result Sets endpoints.
﻿
Example
﻿GET  /batches/BATCH_ID
In the example below we Get a Batch with id=123456 :
HTTP
Curl
Node.js
Python
PHP
https://api.valueserp.com/batches/123456?api_key=demo
https://api.valueserp.com/batches/123456?api_key=demo
﻿
VALUE SERP responds with the following JSON showing all details of the Batch:
JSON
{
  "request_info": {
    "success": true
  },
  "batch": {
    "id": "123456",
    "created_at": "2020-01-01T00:00:00.000Z",
    "name": "My First Batch",
    "schedule_type": "manual/daily/weekly/monthly",
    "priority": "normal",
    "destination_ids": [
      "destination_id_1",
      "destination_id_2"
    ],
    "enabled": true,
    "status": "idle/queued/running",
    "search_total_count": 0,
    "search_page_count": 0,
    "credits_required": 0,
    "next_result_set_id": 1,
    "results_count": 0,
    "schedule_hours": [
      9,
      17
    ],
    "notification_email": "[email protected]",
    "notification_as_json": false,
    "notification_as_jsonlines": false,
    "notification_as_csv": true
  }
}
{
  "request_info": {
    "success": true
  },
  "batch": {
    "id": "123456",
    "created_at": "2020-01-01T00:00:00.000Z",
    "name": "My First Batch",
    "schedule_type": "manual/daily/weekly/monthly",
    "priority": "normal",
    "destination_ids": [
      "destination_id_1",
      "destination_id_2"
    ],
    "enabled": true,
    "status": "idle/queued/running",
    "search_total_count": 0,
    "search_page_count": 0,
    "credits_required": 0,
    "next_result_set_id": 1,
    "results_count": 0,
    "schedule_hours": [
      9,
      17
    ],
    "notification_email": "john.smith@example.com",
    "notification_as_json": false,
    "notification_as_jsonlines": false,
    "notification_as_csv": true
  }
}
﻿
﻿
Next Steps
     List Searches
     List Result Sets﻿

Updated 13 Aug 2024

Did this page help you?

Delete Batch

List Batches