# Ratings

User ratings can be recorded through BotDistrikt's Website Chatbot Widget, providing valuable insights into user satisfaction. This feature is a key tool for monitoring user satisfaction and evaluating the effectiveness of conversations delivered through your bot. In this page, admins could filter through ratings as well as exporting the data in CSV.

{% hint style="info" %}
Note that **this functionality applies only to the Website Chatbot Widget** and i**s not available for Messaging App integrations such as WhatsApp, Telegram, Facebook Messenger, or Instagram.**
{% endhint %}

### **How Ratings Are Collected**

* The rating screen is displayed in the following scenarios:
  1. When the user **closes the chat** by pressing the **X button**.
  2. When the user **clicks "Restart"** to begin a new chat session.
* At this point, the user can:
  * Select a star rating (1 to 5).
  * Provide optional text feedback about their experience.

<figure><img src="/files/rCMskV9GJKHF65VIHbdH" alt="" width="375"><figcaption><p>User Rating on Session Close</p></figcaption></figure>

After a rating is submitted, it will be visible in **Inbox** **> Ratings**. Recorded ratings can be filtered by all column categories and exported to CSV.

<figure><img src="/files/Njh1RGVLElzf9JOx30h1" alt=""><figcaption><p>Recorded User Ratings</p></figcaption></figure>

### Filtering Ratings

Use the Filters on the top of the page to filter ratings based on several fields. Each field has a specific filter use case.

<figure><img src="/files/3PqzdUpLHgz22SpXFPdO" alt=""><figcaption><p>Ratings Tab Filter Options</p></figcaption></figure>

<table><thead><tr><th width="210">Field</th><th>Use case</th></tr></thead><tbody><tr><td>User ID</td><td>Finds all ratings associated with a specific user.</td></tr><tr><td>User Name</td><td>Find all ratings from a specific user, filterable by the user's name.</td></tr><tr><td>Channel</td><td>Finds all ratings on a specific platform.</td></tr><tr><td>Widget ID</td><td>Finds all ratings linked to a specific widget. Only applies to Website Bot Widgets and cannot be used for Messaging Apps.</td></tr><tr><td>Rating</td><td>Finds all ratings provided by users.</td></tr><tr><td>Feedback</td><td>Finds all user-provided feedback.</td></tr><tr><td>Recorded At</td><td>Find all reactions made before or after a specific date and time.</td></tr></tbody></table>

### Exporting to CSV

Filter rating logs by clicking on **add filter** and selecting the appropriate attribute and function for the search parameter. To export filtered logs, click on **Select Action** and **Export rows to CSV**.

<figure><img src="/files/XBsW9JySK87b43cR9Ebk" alt=""><figcaption></figcaption></figure>

**Export to CSV** will generate a .csv file with the following fields:

<table><thead><tr><th width="216">Field</th><th>Description</th></tr></thead><tbody><tr><td>ID</td><td>An identifier based on the unique Message ID.</td></tr><tr><td>Rating</td><td>The score over 5 that the user provides to rate the bot's response or interaction quality.</td></tr><tr><td>Feedback</td><td>Any additional input or remarks provided by the user regarding the interaction.</td></tr><tr><td>User ID</td><td>A unique identifier assigned to the user.</td></tr><tr><td>User</td><td>The display name or alias of the user involved in the interaction.</td></tr><tr><td>Channel</td><td>The platform or medium through which the interaction occurred.</td></tr><tr><td>Widget ID</td><td>Only applies to Website Bot Widgets and cannot be used for Messaging Apps.</td></tr><tr><td>Date [Timezone]</td><td>This column reflects the timezone of the user exporting the data. For example, if the export is generated in New York, the column will show 'Date [GMT-05:00]'.</td></tr><tr><td>Chat History Link</td><td>A URL or link to access the complete chat history for the interaction.</td></tr></tbody></table>

### Toggling Ratings

Collect Ratings can be toggled on and off at the Widget level. To access the toggle, go to **Integrations** **> Website**. If the Collecting Ratings toggle is inactive, users will not be prompted to rate their experience on session close. If it is turned on, the ratings feature will only apply to that website chat widget.

<figure><img src="/files/shqU9VfP8NQhwt6Ysx32" alt=""><figcaption><p>Navigating to Ratings Toggle</p></figcaption></figure>

<figure><img src="/files/Sdzapg08A6wAy5zWmPbI" alt=""><figcaption><p>Collect Ratings Toggle</p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.botdistrikt.com/features/inbox/ratings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
