v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB
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

Request body

Example request

{
  "query": {
    "text": "Type a theme to get volume stats...."
  }
}

Response

Volume search results

Example response

{
  "results": {
    "volume": [
      {
        "date": "2025-01-01",
        "documents": 164,
        "chunks": 387,
        "sentiment": -0.15
      }
    ],
    "total": {
      "documents": 3440,
      "chunks": 8196,
      "sentiment": -0.18
    }
  },
  "metadata": {
    "request_id": "473d22ea-7753-41d8-825a-4a4c7696f8cb",
    "timestamp": "2025-12-15T17:34:34.181589+00:00"
  },
  "usage": {
    "api_query_units": 0.7
  }
}