SERP Batch
curl --request POST \
--url https://sdk.nimbleway.com/v2/serp/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": true,
"query": "nimble web data",
"render": false,
"search_engine": "google_search",
"show_hidden_results": false,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": true,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
],
"shared_inputs": {
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": true,
"query": "nimble web data",
"render": false,
"search_engine": "google_search",
"show_hidden_results": false,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": true,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
}
'import requests
url = "https://sdk.nimbleway.com/v2/serp/batch"
payload = {
"inputs": [
{
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": True,
"query": "nimble web data",
"render": False,
"search_engine": "google_search",
"show_hidden_results": False,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": True,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
],
"shared_inputs": {
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": True,
"query": "nimble web data",
"render": False,
"search_engine": "google_search",
"show_hidden_results": False,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": True,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
country: 'US',
device: 'desktop',
domain: 'com',
locale: 'en',
location: 'New York, New York, United States',
num_results: 10,
page: 1,
parse: true,
query: 'nimble web data',
render: false,
search_engine: 'google_search',
show_hidden_results: false,
callback_url: 'https://example.com/webhook/callback',
storage_compress: true,
storage_object_name: 'result-2024-01-15.json',
storage_type: 's3',
storage_url: 's3://bucket-name/path/to/object'
}
],
shared_inputs: {
country: 'US',
device: 'desktop',
domain: 'com',
locale: 'en',
location: 'New York, New York, United States',
num_results: 10,
page: 1,
parse: true,
query: 'nimble web data',
render: false,
search_engine: 'google_search',
show_hidden_results: false,
callback_url: 'https://example.com/webhook/callback',
storage_compress: true,
storage_object_name: 'result-2024-01-15.json',
storage_type: 's3',
storage_url: 's3://bucket-name/path/to/object'
}
})
};
fetch('https://sdk.nimbleway.com/v2/serp/batch', 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://sdk.nimbleway.com/v2/serp/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inputs' => [
[
'country' => 'US',
'device' => 'desktop',
'domain' => 'com',
'locale' => 'en',
'location' => 'New York, New York, United States',
'num_results' => 10,
'page' => 1,
'parse' => true,
'query' => 'nimble web data',
'render' => false,
'search_engine' => 'google_search',
'show_hidden_results' => false,
'callback_url' => 'https://example.com/webhook/callback',
'storage_compress' => true,
'storage_object_name' => 'result-2024-01-15.json',
'storage_type' => 's3',
'storage_url' => 's3://bucket-name/path/to/object'
]
],
'shared_inputs' => [
'country' => 'US',
'device' => 'desktop',
'domain' => 'com',
'locale' => 'en',
'location' => 'New York, New York, United States',
'num_results' => 10,
'page' => 1,
'parse' => true,
'query' => 'nimble web data',
'render' => false,
'search_engine' => 'google_search',
'show_hidden_results' => false,
'callback_url' => 'https://example.com/webhook/callback',
'storage_compress' => true,
'storage_object_name' => 'result-2024-01-15.json',
'storage_type' => 's3',
'storage_url' => 's3://bucket-name/path/to/object'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sdk.nimbleway.com/v2/serp/batch"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n ],\n \"shared_inputs\": {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sdk.nimbleway.com/v2/serp/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n ],\n \"shared_inputs\": {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v2/serp/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n ],\n \"shared_inputs\": {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"batch_size": 123,
"tasks": [
{
"_query": "<unknown>",
"created_at": "2024-01-15T10:30:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"input": "<unknown>",
"state": "pending",
"status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000",
"account_name": "<string>",
"api_type": "web",
"batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
"download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
"error": "Connection timeout",
"error_type": "timeout_error",
"modified_at": "2024-01-15T10:35:00Z",
"output_url": "<string>",
"queue": "<string>",
"status_code": 200
}
]
}SERP Batch
POST
/
v2
/
serp
/
batch
SERP Batch
curl --request POST \
--url https://sdk.nimbleway.com/v2/serp/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": true,
"query": "nimble web data",
"render": false,
"search_engine": "google_search",
"show_hidden_results": false,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": true,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
],
"shared_inputs": {
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": true,
"query": "nimble web data",
"render": false,
"search_engine": "google_search",
"show_hidden_results": false,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": true,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
}
'import requests
url = "https://sdk.nimbleway.com/v2/serp/batch"
payload = {
"inputs": [
{
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": True,
"query": "nimble web data",
"render": False,
"search_engine": "google_search",
"show_hidden_results": False,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": True,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
],
"shared_inputs": {
"country": "US",
"device": "desktop",
"domain": "com",
"locale": "en",
"location": "New York, New York, United States",
"num_results": 10,
"page": 1,
"parse": True,
"query": "nimble web data",
"render": False,
"search_engine": "google_search",
"show_hidden_results": False,
"callback_url": "https://example.com/webhook/callback",
"storage_compress": True,
"storage_object_name": "result-2024-01-15.json",
"storage_type": "s3",
"storage_url": "s3://bucket-name/path/to/object"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
country: 'US',
device: 'desktop',
domain: 'com',
locale: 'en',
location: 'New York, New York, United States',
num_results: 10,
page: 1,
parse: true,
query: 'nimble web data',
render: false,
search_engine: 'google_search',
show_hidden_results: false,
callback_url: 'https://example.com/webhook/callback',
storage_compress: true,
storage_object_name: 'result-2024-01-15.json',
storage_type: 's3',
storage_url: 's3://bucket-name/path/to/object'
}
],
shared_inputs: {
country: 'US',
device: 'desktop',
domain: 'com',
locale: 'en',
location: 'New York, New York, United States',
num_results: 10,
page: 1,
parse: true,
query: 'nimble web data',
render: false,
search_engine: 'google_search',
show_hidden_results: false,
callback_url: 'https://example.com/webhook/callback',
storage_compress: true,
storage_object_name: 'result-2024-01-15.json',
storage_type: 's3',
storage_url: 's3://bucket-name/path/to/object'
}
})
};
fetch('https://sdk.nimbleway.com/v2/serp/batch', 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://sdk.nimbleway.com/v2/serp/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inputs' => [
[
'country' => 'US',
'device' => 'desktop',
'domain' => 'com',
'locale' => 'en',
'location' => 'New York, New York, United States',
'num_results' => 10,
'page' => 1,
'parse' => true,
'query' => 'nimble web data',
'render' => false,
'search_engine' => 'google_search',
'show_hidden_results' => false,
'callback_url' => 'https://example.com/webhook/callback',
'storage_compress' => true,
'storage_object_name' => 'result-2024-01-15.json',
'storage_type' => 's3',
'storage_url' => 's3://bucket-name/path/to/object'
]
],
'shared_inputs' => [
'country' => 'US',
'device' => 'desktop',
'domain' => 'com',
'locale' => 'en',
'location' => 'New York, New York, United States',
'num_results' => 10,
'page' => 1,
'parse' => true,
'query' => 'nimble web data',
'render' => false,
'search_engine' => 'google_search',
'show_hidden_results' => false,
'callback_url' => 'https://example.com/webhook/callback',
'storage_compress' => true,
'storage_object_name' => 'result-2024-01-15.json',
'storage_type' => 's3',
'storage_url' => 's3://bucket-name/path/to/object'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sdk.nimbleway.com/v2/serp/batch"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n ],\n \"shared_inputs\": {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sdk.nimbleway.com/v2/serp/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n ],\n \"shared_inputs\": {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdk.nimbleway.com/v2/serp/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n ],\n \"shared_inputs\": {\n \"country\": \"US\",\n \"device\": \"desktop\",\n \"domain\": \"com\",\n \"locale\": \"en\",\n \"location\": \"New York, New York, United States\",\n \"num_results\": 10,\n \"page\": 1,\n \"parse\": true,\n \"query\": \"nimble web data\",\n \"render\": false,\n \"search_engine\": \"google_search\",\n \"show_hidden_results\": false,\n \"callback_url\": \"https://example.com/webhook/callback\",\n \"storage_compress\": true,\n \"storage_object_name\": \"result-2024-01-15.json\",\n \"storage_type\": \"s3\",\n \"storage_url\": \"s3://bucket-name/path/to/object\"\n }\n}"
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"batch_size": 123,
"tasks": [
{
"_query": "<unknown>",
"created_at": "2024-01-15T10:30:00Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"input": "<unknown>",
"state": "pending",
"status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000",
"account_name": "<string>",
"api_type": "web",
"batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
"download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
"error": "Connection timeout",
"error_type": "timeout_error",
"modified_at": "2024-01-15T10:35:00Z",
"output_url": "<string>",
"queue": "<string>",
"status_code": 200
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Array of SERP requests. Each object can include search parameters and async/storage settings.
Minimum array length:
1Show child attributes
Show child attributes
Shared parameters applied to the entire batch. Can include search parameters and async/storage settings.
Show child attributes
Show child attributes
Was this page helpful?