Skip to main content
POST
/
api
/
analytics
/
search
Get Search Analytics
curl --request POST \
  --url https://api.trieve.ai/api/analytics/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "filter": {
    "component_name": "<string>",
    "date_range": {
      "gt": "2021-01-01 00:00:00.000",
      "gte": "2021-01-01 00:00:00.000",
      "lt": "2021-01-01 00:00:00.000",
      "lte": "2021-01-01 00:00:00.000"
    },
    "query": "<string>",
    "query_rating": {
      "gt": 1,
      "gte": 1,
      "lt": 1,
      "lte": 1
    },
    "search_method": "fulltext",
    "search_type": "search",
    "top_score": {
      "gt": 123,
      "gte": 123,
      "lt": 123,
      "lte": 123
    }
  },
  "granularity": "minute",
  "type": "latency_graph"
}'
{
  "points": [
    {
      "point": 123,
      "time_stamp": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Headers

TR-Dataset
string<uuid>
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json

JSON request payload to filter the graph

  • LatencyGraph
  • SearchUsageGraph
  • SearchMetrics
  • HeadQueries
  • LowConfidenceQueries
  • NoResultQueries
  • SearchQueries
  • CountQueries
  • QueryDetails
  • PopularFilters
  • CTRMetricsOverTime
  • SearchConversionRate
  • SearchesPerUser
  • SearchAverageRating
  • EventFunnel
  • SearchRevenue
type
enum<string>
required
Available options:
latency_graph
filter
object
granularity
enum<string>
Available options:
minute,
second,
hour,
day,
month

Response

The search analytics for the dataset

  • LatencyGraphResponse
  • SearchUsageGraphResponse
  • SearchMetricsResponse
  • HeadQueryResponse
  • SearchQueryResponse
  • SearchQueryResponse
  • SearchQueryResponse
  • QueryCountResponse
  • SearchQueryEvent
  • PopularFiltersResponse
  • Option 11
  • Option 12
  • Option 13
  • Option 14
  • Option 15
  • Option 16
points
object[]
required