Get Batch Job Info
curl --request GET \
--url https://api.bigdata.com/v1/search/batches/{batch_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search/batches/{batch_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.bigdata.com/v1/search/batches/{batch_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bigdata.com/v1/search/batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/search/batches/{batch_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bigdata.com/v1/search/batches/{batch_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search/batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"status": "pending",
"output_file_url": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Batch Search
Get Batch Job Info
Check the status of your batch job and retrieve results when processing is complete.
batch_id: Your job’s unique identifierstatus: Current processing state (pending, processing, completed, failed, or cancelled)estimated_completion_time: A dynamic ISO 8601 timestamp indicating when the job is expected to finish. This adjusts in real-time based on system throughput and queue backlog.output_file_url: Download link for your results (available when status is completed)
Once your batch reaches completed status, use the output_file_url to download a .jsonl file containing all results via a simple GET request.
Each line in your results file contains:
| Field | Type | Description |
|---|---|---|
| line_number | int | Matches the line number from your original input file |
| status | string | Result status: success, error, timeout, or exception |
| query | object | The original search query you submitted |
| response | object | The Search response for this query |
| code | int | HTTP status code |
| error | string | Error description (only present if request failed) |
For a step-by-step walkthrough, see the Batch Search how-to guide.
GET
/
v1
/
search
/
batches
/
{batch_id}
Get Batch Job Info
curl --request GET \
--url https://api.bigdata.com/v1/search/batches/{batch_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.bigdata.com/v1/search/batches/{batch_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.bigdata.com/v1/search/batches/{batch_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bigdata.com/v1/search/batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/search/batches/{batch_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bigdata.com/v1/search/batches/{batch_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search/batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"status": "pending",
"output_file_url": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Authorizations
Path Parameters
Response
OK
The unique identifier for your batch job.
Current processing state of your batch job. Poll this endpoint until status reaches completed or failed.
Available options:
pending, processing, completed, failed, cancelled Presigned URL to download your results. Available only when status is completed. Use a simple GET request to download the .jsonl results file.
Was this page helpful?