---
title: "Get Recommendation Analytics"
method: POST
path: "/api/analytics/recommendations"
tags: ["Analytics"]
---

# Get Recommendation Analytics

`POST /api/analytics/recommendations`

This route allows you to view the recommendation analytics for a dataset.

## Headers

- `TR-Dataset` string, uuid, required

## Request body

- union
  - object
    - `filter` RecommendationAnalyticsFilter
      - `component_name` string, nullable
      - `date_range` DateRange — 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.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
      - `recommendation_type` 'Chunk' | 'Group'
      - `top_score` FloatRange
        - `gt` number, double, nullable
        - `gte` number, double, nullable
        - `lt` number, double, nullable
        - `lte` number, double, nullable
    - `page` integer, nullable
    - `threshold` number, float, nullable
    - `type` 'low_confidence_recommendations', required
  - object
    - `filter` RecommendationAnalyticsFilter
      - `component_name` string, nullable
      - `date_range` DateRange — 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.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
      - `recommendation_type` 'Chunk' | 'Group'
      - `top_score` FloatRange
        - `gt` number, double, nullable
        - `gte` number, double, nullable
        - `lt` number, double, nullable
        - `lte` number, double, nullable
    - `has_clicks` boolean, nullable
    - `page` integer, nullable
    - `sort_by` 'created_at' | 'top_score'
    - `sort_order` 'desc' | 'asc'
    - `type` 'recommendation_queries', required
  - object
    - `request_id` string, uuid, required
    - `type` 'query_details', required
  - object
    - `filter` RecommendationAnalyticsFilter
      - `component_name` string, nullable
      - `date_range` DateRange — 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.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
      - `recommendation_type` 'Chunk' | 'Group'
      - `top_score` FloatRange
        - `gt` number, double, nullable
        - `gte` number, double, nullable
        - `lt` number, double, nullable
        - `lte` number, double, nullable
    - `granularity` 'minute' | 'second' | 'hour' | 'day' | 'month'
    - `type` 'recommendation_usage_graph', required
  - object
    - `filter` RecommendationAnalyticsFilter
      - `component_name` string, nullable
      - `date_range` DateRange — 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.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
      - `recommendation_type` 'Chunk' | 'Group'
      - `top_score` FloatRange
        - `gt` number, double, nullable
        - `gte` number, double, nullable
        - `lt` number, double, nullable
        - `lte` number, double, nullable
    - `granularity` 'minute' | 'second' | 'hour' | 'day' | 'month'
    - `type` 'recommendations_per_user', required
  - object
    - `filter` RecommendationAnalyticsFilter
      - `component_name` string, nullable
      - `date_range` DateRange — 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.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
      - `recommendation_type` 'Chunk' | 'Group'
      - `top_score` FloatRange
        - `gt` number, double, nullable
        - `gte` number, double, nullable
        - `lt` number, double, nullable
        - `lte` number, double, nullable
    - `granularity` 'minute' | 'second' | 'hour' | 'day' | 'month'
    - `type` 'recommendations_ctr_rate', required
  - object
    - `filter` RecommendationAnalyticsFilter
      - `component_name` string, nullable
      - `date_range` DateRange — 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.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
      - `recommendation_type` 'Chunk' | 'Group'
      - `top_score` FloatRange
        - `gt` number, double, nullable
        - `gte` number, double, nullable
        - `lt` number, double, nullable
        - `lte` number, double, nullable
    - `granularity` 'minute' | 'second' | 'hour' | 'day' | 'month'
    - `type` 'recommendation_conversion_rate', required
  - object
    - `filter` RecommendationAnalyticsFilter
      - `component_name` string, nullable
      - `date_range` DateRange — 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.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
      - `recommendation_type` 'Chunk' | 'Group'
      - `top_score` FloatRange
        - `gt` number, double, nullable
        - `gte` number, double, nullable
        - `lt` number, double, nullable
        - `lte` number, double, nullable
    - `type` 'event_funnel', required

## Response `200`

The recommendation analytics for the dataset

- union
  - RecommendationsEventResponse
    - `queries` RecommendationEvent[], required
      - `created_at` string, required
      - `dataset_id` string, uuid, required
      - `id` string, uuid, required
      - `metadata` unknown
      - `negative_ids` string[], required
      - `negative_tracking_ids` string[], required
      - `positive_ids` string[], required
      - `positive_tracking_ids` string[], required
      - `recommendation_type` 'Chunk' | 'Group', required
      - `request_params` unknown, required
      - `results` unknown[], required
        - unknown
      - `top_score` number, float, required
      - `user_id` string, required
  - RecommendationsEventResponse
    - `queries` RecommendationEvent[], required
      - `created_at` string, required
      - `dataset_id` string, uuid, required
      - `id` string, uuid, required
      - `metadata` unknown
      - `negative_ids` string[], required
      - `negative_tracking_ids` string[], required
      - `positive_ids` string[], required
      - `positive_tracking_ids` string[], required
      - `recommendation_type` 'Chunk' | 'Group', required
      - `request_params` unknown, required
      - `results` unknown[], required
        - unknown
      - `top_score` number, float, required
      - `user_id` string, required
  - RecommendationEvent
    - `created_at` string, required
    - `dataset_id` string, uuid, required
    - `id` string, uuid, required
    - `metadata` unknown
    - `negative_ids` string[], required
    - `negative_tracking_ids` string[], required
    - `positive_ids` string[], required
    - `positive_tracking_ids` string[], required
    - `recommendation_type` 'Chunk' | 'Group', required
    - `request_params` unknown, required
    - `results` unknown[], required
      - unknown
    - `top_score` number, float, required
    - `user_id` string, required
  - RecommendationUsageGraphResponse
    - `points` IntegerTimePoint[], required
      - `point` integer, required
      - `time_stamp` string, required
    - `total_requests` integer, required
  - RecommendationsPerUserResponse
    - `avg_recommendations_per_user` number, double, required
    - `points` FloatTimePoint[], required
      - `point` number, double, required
      - `time_stamp` string, required
  - RecommendationsCTRRateResponse
    - `points` FloatTimePoint[], required
      - `point` number, double, required
      - `time_stamp` string, required
    - `total_ctr` number, double, required
  - RecommendationsConversionRateResponse
    - `conversion_rate` number, double, required
    - `points` FloatTimePoint[], required
      - `point` number, double, required
      - `time_stamp` string, required
  - EventNameAndCountsResponse
    - `event_names` EventNameAndCounts[], required
      - `event_count` integer, required
      - `event_name` string, required

## Other responses

- `400` — Service error relating to getting recommendation analytics

---

[API](https://skmtc.net/devflowinc/apis/trieve-api.md) · [All operations](https://skmtc.net/devflowinc/apis/trieve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/devflowinc/trieve-api/revisions/84583e7c9fc1/schema)