Search volume
curl --request POST \
--url https://api.bigdata.com/v1/search/volume \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"query": {
"text": "Type a theme to get volume stats...."
}
}
'import requests
url = "https://api.bigdata.com/v1/search/volume"
payload = { "query": { "text": "Type a theme to get volume stats...." } }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: {text: 'Type a theme to get volume stats....'}})
};
fetch('https://api.bigdata.com/v1/search/volume', 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/volume",
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([
'query' => [
'text' => 'Type a theme to get volume stats....'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/search/volume"
payload := strings.NewReader("{\n \"query\": {\n \"text\": \"Type a theme to get volume stats....\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api.bigdata.com/v1/search/volume")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": {\n \"text\": \"Type a theme to get volume stats....\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search/volume")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": {\n \"text\": \"Type a theme to get volume stats....\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": {
"volume": [
{
"date": "2025-01-01",
"documents": 164,
"chunks": 387,
"sentiment": -0.15
}
],
"total": {
"documents": 3440,
"chunks": 8196,
"sentiment": -0.18
},
"groups": {
"sources": [
{
"id": "B1A50F",
"documents": 58,
"chunks": 130
}
],
"tiers": [
{
"id": "premium-news",
"documents": 412,
"chunks": 889
}
],
"packages": [
{
"id": "public",
"documents": 672,
"chunks": 889
}
]
}
},
"usage": {
"api_query_units": 0.7
},
"metadata": {
"request_id": "473d22ea-7753-41d8-825a-4a4c7696f8cb",
"timestamp": "2025-12-15T17:34:34.181589+00:00"
}
}Search
Search volume
Get document and chunk volume statistics over time for a search query, aggregated by date with sentiment analysis.
POST
/
v1
/
search
/
volume
Search volume
curl --request POST \
--url https://api.bigdata.com/v1/search/volume \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"query": {
"text": "Type a theme to get volume stats...."
}
}
'import requests
url = "https://api.bigdata.com/v1/search/volume"
payload = { "query": { "text": "Type a theme to get volume stats...." } }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: {text: 'Type a theme to get volume stats....'}})
};
fetch('https://api.bigdata.com/v1/search/volume', 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/volume",
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([
'query' => [
'text' => 'Type a theme to get volume stats....'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bigdata.com/v1/search/volume"
payload := strings.NewReader("{\n \"query\": {\n \"text\": \"Type a theme to get volume stats....\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api.bigdata.com/v1/search/volume")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": {\n \"text\": \"Type a theme to get volume stats....\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bigdata.com/v1/search/volume")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": {\n \"text\": \"Type a theme to get volume stats....\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": {
"volume": [
{
"date": "2025-01-01",
"documents": 164,
"chunks": 387,
"sentiment": -0.15
}
],
"total": {
"documents": 3440,
"chunks": 8196,
"sentiment": -0.18
},
"groups": {
"sources": [
{
"id": "B1A50F",
"documents": 58,
"chunks": 130
}
],
"tiers": [
{
"id": "premium-news",
"documents": 412,
"chunks": 889
}
],
"packages": [
{
"id": "public",
"documents": 672,
"chunks": 889
}
]
}
},
"usage": {
"api_query_units": 0.7
},
"metadata": {
"request_id": "473d22ea-7753-41d8-825a-4a4c7696f8cb",
"timestamp": "2025-12-15T17:34:34.181589+00:00"
}
}Authorizations
Body
application/json
Provide at least one of text, texts or filters.
Show child attributes
Show child attributes
Break the volume down by where the matching documents come from. Any combination of source, tier. package also supported for enterprise users on unit-based consumption model.
Minimum array length:
1Available options:
source, tier, package Example:
["source"]
Response
200 - application/json
Volume search results
Volume statistics aggregated by date and totals.
Show child attributes
Show child attributes
API usage for the request. Shape depends on the account consumption model.
- Query Units
- Tokens
Show child attributes
Show child attributes
Request metadata and timing information.
Show child attributes
Show child attributes
Was this page helpful?