Skip to main content
POST
/
api
/
analytics
/
recommendations
curl --request POST \
  --url https://api.trieve.ai/api/analytics/recommendations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "filter": {
    "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"
    }
  }
}'
{
  "queries": [
    {
      "created_at": "<string>",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "negative_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "negative_tracking_ids": [
        "<string>"
      ],
      "positive_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "positive_tracking_ids": [
        "<string>"
      ],
      "recommendation_type": "Chunk",
      "request_params": "<unknown>",
      "results": [
        "<unknown>"
      ],
      "top_score": 123,
      "user_id": "<string>",
      "metadata": "<unknown>"
    }
  ]
}

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

  • LowConfidenceRecommendations
  • RecommendationQueries
  • QueryDetails
  • RecommendationUsageGraph
  • RecommendationsPerUser
  • RecommendationsCTRRate
  • RecommendationConversionRate
  • EventFunnel
​
type
enum<string>
required
Available options:
low_confidence_recommendations
​
filter
object
​
page
integer<int32> | null
Required range: x >= 0
​
threshold
number<float> | null

Response

The recommendation analytics for the dataset

  • RecommendationsWithClicks
  • RecommendationsWithClicks
  • Option 3
  • RecommendationUsageGraphResponse
  • Option 5
  • Option 6
  • Option 7
  • Option 8
​
queries
object[]
required