Get Index Stats - Upstash Documentation

get/search/{id}/stats

Request example

curl --request GET \
  --url 'https://api.upstash.com/v2/search/{id}/stats?period=3h' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.upstash.com/v2/search/{id}/stats?period=3h"
headers = {
    "Authorization": "Basic <encoded-value>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.upstash.com/v2/search/{id}/stats?period=3h', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic <encoded-value>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.upstash.com/v2/search/{id}/stats?period=3h',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Basic <encoded-value>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.upstash.com/v2/search/{id}/stats?period=3h"

	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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.upstash.com/v2/search/{id}/stats?period=3h"))
    .header("Authorization", "Basic <encoded-value>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.upstash.com/v2/search/{id}/stats?period=3h')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

response = http.request(request)
puts response.read_body

Response

{
  "pending_index_count": 1,
  "current_vector_count": 1000,
  "daily_query_count": 100,
  "daily_update_count": 10,
  "monthly_query_count": 1000,
  "monthly_update_count": 1000,
  "monthly_bandwidth_usage": 7000,
  "storage_usage": 7000,
  "monthly_cost": 0.5,
  "daily_update_requests": [
    {
      "x": "2025-10-19 18:33:05.244068975 +0000 UTC",
      "y": 1
    }
  ],
  "daily_query_requests": [
    {
      "x": "2025-10-19 18:33:05.244068975 +0000 UTC",
      "y": 7
    }
  ],
  "daily_bandwidths": [
    {
      "x": "2025-10-19 18:33:05.244068975 +0000 UTC",
      "y": 7
    }
  ],
  "days": [
    "Sunday",
    "Monday",
    "Tuesday",
    "Wednesday",
    "Thursday"
  ],
  "query_throughput": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 7
    }
  ],
  "update_throughput": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 7
    }
  ],
  "query_latency_mean": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ],
  "query_latency_99": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ],
  "update_latency_mean": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ],
  "update_latency_99": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ],
  "embeds_latency_mean": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ],
  "embeds_latency_99": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ],
  "vector_count": [
    {
      "x": "2025-10-23 17:35:00.000 +0000 UTC",
      "y": 2
    }
  ],
  "data_size": [
    {
      "x": "2025-10-23 17:35:00.000 +0000 UTC",
      "y": 76
    }
  ],
  "daily_rerank_count": 0,
  "monthly_rerank_count": 10,
  "daily_rerank_requests": [
    {
      "x": "2025-10-19 18:33:05.244068975 +0000 UTC",
      "y": 1
    }
  ],
  "rerank_latency_mean": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ],
  "rerank_latency_99": [
    {
      "x": "2025-10-23 17:34:00.000 +0000 UTC",
      "y": 0
    }
  ]
}

get/search/{id}/stats

Authorization

Authorizationstringheaderrequired#

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

Path parameters

idstringrequired#

The ID of the search index

Query parameters

periodenum<string>#

Time period for statistics aggregation. Each period returns 60 datapoints
with intervals adjusted to the period length.

Exceptionally for 30 days, it returns 240 datapoints with 3-hour intervals for increased granularity.

Default: "1h"

Options:1h3h12h1d3d7d30d

Responses

application/json

200

Statistics for the specified search index retrieved successfully

pending_index_countinteger#

Number of pending index operations

Example:1

current_vector_countinteger#

Current number of vectors in the index

Example:1000

daily_query_countinteger#

Total number of query operations executed today

Example:100

daily_update_countinteger#

Total number of update operations executed today

Example:10

monthly_query_countinteger#

Total query operations in current month

Example:1000

monthly_update_countinteger#

Total update operations in current month

Example:1000

monthly_bandwidth_usageinteger#

Total bandwidth used in current month (bytes)

Example:7000

storage_usageinteger#

Current storage used (bytes)

Example:7000

monthly_costnumber#

Total cost in current month

Example:0.5

daily_update_requestsobject[]#

Daily update requests over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-19 18:33:05.244068975 +0000 UTC",    "y": 1  }]

daily_query_requestsobject[]#

Daily query requests over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-19 18:33:05.244068975 +0000 UTC",    "y": 7  }]

daily_bandwidthsobject[]#

Daily bandwidth usage over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-19 18:33:05.244068975 +0000 UTC",    "y": 7  }]

daysstring[]#

Days of the week for measurement

Example:

[  "Sunday",  "Monday",  "Tuesday",  "Wednesday",  "Thursday"]

query_throughputobject[]#

Query throughput over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 7  }]

update_throughputobject[]#

Update throughput over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 7  }]

query_latency_meanobject[]#

Average query latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

query_latency_99object[]#

99th percentile query latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

update_latency_meanobject[]#

Average update latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

update_latency_99object[]#

99th percentile update latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

embeds_latency_meanobject[]#

Average embedding latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

embeds_latency_99object[]#

99th percentile embedding latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

vector_countobject[]#

Vector count over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:35:00.000 +0000 UTC",    "y": 2  }]

data_sizeobject[]#

Data size over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:35:00.000 +0000 UTC",    "y": 76  }]

daily_rerank_countinteger#

Total number of rerank operations executed today

Example:0

monthly_rerank_countinteger#

Total rerank operations in current month

Example:10

daily_rerank_requestsobject[]#

Daily rerank requests over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-19 18:33:05.244068975 +0000 UTC",    "y": 1  }]

rerank_latency_meanobject[]#

Average rerank latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

rerank_latency_99object[]#

99th percentile rerank latency over time

Show child attributes

xstringrequired#

Timestamp when measurement was taken

Example:"2023-05-22 10:59:23.426 +0000 UTC"

ynumberrequired#

The measured value

Example:320

Example:

[  {    "x": "2025-10-23 17:34:00.000 +0000 UTC",    "y": 0  }]

Get Search Stats Create Search Index