Get Recommendation Analytics

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": {
    "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"
    },
    "recommendation_type": "Chunk",
    "top_score": {
      "gt": 123,
      "gte": 123,
      "lt": 123,
      "lte": 123
    }
  },
  "page": 1,
  "threshold": 123,
  "type": "low_confidence_recommendations"
}'

{
  "queries": [
    {
      "created_at": "<string>",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": "<any>",
      "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": "<any>",
      "results": [
        "<any>"
      ],
      "top_score": 123,
      "user_id": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Headers

TR-Dataset

string

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

type

enum<string>

required

Available options:

low_confidence_recommendations

filter

object

filter.component_name

string | null

filter.date_range

object

DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone.

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

page

integer | null

Required range: x >= 0

threshold

number | null

type

enum<string>

required

Available options:

low_confidence_recommendations

filter

object

filter.component_name

string | null

filter.date_range

object

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

page

integer | null

Required range: x >= 0

threshold

number | null

type

enum<string>

required

Available options:

recommendation_queries

filter

object

filter.component_name

string | null

filter.date_range

object

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

has_clicks

boolean | null

page

integer | null

Required range: x >= 0

sort_by

enum<string>

Available options:

created_at,

top_score

sort_order

enum<string>

Available options:

desc,

asc

request_id

string

required

type

enum<string>

required

Available options:

query_details

type

enum<string>

required

Available options:

recommendation_usage_graph

filter

object

filter.component_name

string | null

filter.date_range

object

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

granularity

enum<string>

Available options:

minute,

second,

hour,

day,

month

type

enum<string>

required

Available options:

recommendations_per_user

filter

object

filter.component_name

string | null

filter.date_range

object

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

granularity

enum<string>

Available options:

minute,

second,

hour,

day,

month

type

enum<string>

required

Available options:

recommendations_ctr_rate

filter

object

filter.component_name

string | null

filter.date_range

object

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

granularity

enum<string>

Available options:

minute,

second,

hour,

day,

month

type

enum<string>

required

Available options:

recommendation_conversion_rate

filter

object

filter.component_name

string | null

filter.date_range

object

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

granularity

enum<string>

Available options:

minute,

second,

hour,

day,

month

type

enum<string>

required

Available options:

event_funnel

filter

object

filter.component_name

string | null

filter.date_range

object

Example:

{
  "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"
}

filter.recommendation_type

enum<string>

Available options:

Chunk,

Group

filter.top_score

object

Response

200

application/json

The recommendation analytics for the dataset

queries

object[]

required

queries

object[]

required

queries

object[]

required

created_at

string

required

dataset_id

string

required

string

required

negative_ids

string[]

required

negative_tracking_ids

string[]

required

positive_ids

string[]

required

positive_tracking_ids

string[]

required

recommendation_type

enum<string>

required

Available options:

Chunk,

Group

request_params

any

required

results

any[]

required

top_score

number

required

user_id

string

required

metadata

any | null

points

object[]

required

total_requests

integer

required

Required range: x >= 0

avg_recommendations_per_user

number

required

points

object[]

required

points

object[]

required

total_ctr

number

required

conversion_rate

number

required

points

object[]

required

event_names

object[]

required

Was this page helpful?

Raise issue

Get RAG Analytics Get Search Analytics

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": {
    "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"
    },
    "recommendation_type": "Chunk",
    "top_score": {
      "gt": 123,
      "gte": 123,
      "lt": 123,
      "lte": 123
    }
  },
  "page": 1,
  "threshold": 123,
  "type": "low_confidence_recommendations"
}'

{
  "queries": [
    {
      "created_at": "<string>",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": "<any>",
      "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": "<any>",
      "results": [
        "<any>"
      ],
      "top_score": 123,
      "user_id": "<string>"
    }
  ]
}

Chunk

Chunk Group

Topic

Message

Crawl

File

Analytics

Dataset

Organization

User

Auth

Health

Invitation

Stripe

Metrics

Get Recommendation Analytics

Authorizations

Headers

Body

Response