Skip to main content
GET
/
search
/
stats
Get Search Stats
curl --request GET \
  --url https://api.upstash.com/v2/search/stats \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.upstash.com/v2/search/stats"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.upstash.com/v2/search/stats', 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.upstash.com/v2/search/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);

$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.upstash.com/v2/search/stats"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Basic <encoded-value>")

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.upstash.com/v2/search/stats")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.upstash.com/v2/search/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "record_count": 10,
  "request": 10,
  "bandwidth": 750,
  "storage": 950,
  "billing": 0.001,
  "rerank_count": 0
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200 - application/json

Statistics for the search indices retrieved successfully

record_count
integer

Total number of indexed records across all indexes

Example:

10

request
integer

Total API requests count across all indexes

Example:

10

bandwidth
integer

Total bandwidth usage in bytes across all indexes

Example:

750

storage
integer

Total storage usage in bytes across all indexes

Example:

950

billing
number<float>

Current billing amount across all indexes

Example:

0.001

rerank_count
integer

Total reranking operations count across all indexes

Example:

0