> For the complete documentation index, see [llms.txt](https://help.solink.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.solink.com/docs/understand-your-business/create-widgets/report-widget.md).
# Report Widget
A **Report** widget displays data from all of your events or up to two individual reports.
An example of a Report widget with transaction count data is displayed in the following image:
To create a **Report** widget, follow these steps:
### Step 1: Select Data Set
Select either:
* **All Events** to pull data from all of your events;
* A specific [**report**](/docs/understand-your-business/search-and-save-reports/create-a-report.md) to pull from and display the report data in the widget.
### Step 2: Choose Data to Display
Choose the data to display in the widget:
1. Select a category to filter the options you have in the **Data Type** field directly below the **Category** field. For example, select the **Analytic** category to choose from Change Due, Refunds Amount, or Total Void Amount data types.
2. Select a data type in the **Data Type** field.
3. Select the type of calculation to be displayed in the widget via the **Statistic** field. Possible statistic calculations include:
* **Average**: Displays the average of the selected data type.
* **Count**: Displays the total count of the selected data type (for example "Transactions (Count)" or "Bookmarks (Count)" default to the Count statistic).
* **Percentage**: Displays a percentage value of the selected data type. A preview displays of how the percentage is calculated (for example, if you select Refunds Amount, the widget displays Refunds Amount as a percentage of total Gross Revenue).
* **Sum**: Displays the sum of the selected data type.
* **Ratio**: Displays a ratio of the selected data type. You can select what to ratio with (for example, you could ratio Refunds Amount with Gross Revenue, or ratio Total Number of Refunded Items with Total Number of Items).
### Step 3: Configure Location(s) and Time Frame
Select the following:
1. Use the **Locations** field to select the location(s) you want to pull data from for the widget. You can select all locations (if you have more than one location) or select individual locations.
2. Use the **Time Frame** field to select the time frame the widget pulls data from. Select the **Use rolling time frame** checkbox if you wish pull data from the last hour, day, week, month or year rather than a given hour, day, month or year.
**Tip:** To create a report widget that uses ***real-time data***, select the **Hour** time frame option in this step. To enable this option, reach out to our [Support](/docs/get-started/introductory-guides/how-to-contact-our-team.md) team.
**Note:** Select **Update With Selected Dashboard Filter** to update the widget location(s) and/or time frame automatically whenever you select the corresponding filter from the Dashboard page. For information on widget filters, see [Set Widget Filters](/docs/understand-your-business/widget-configuration/set-widget-filters.md).
### Step 4: Graph Visuals and Comparison Settings
Configure the following graph visual and comparison settings:
1. Use the **Graph Type** field to select the type of graph the widget displays as. Graph options include:
* Bar graph
* Horizontal bar graph
* Area graph
* Line graph
* Stacked bar graph
* Stacked horizontal bar graph
* Stacked area graph
* Number (displays a large number based on the data)
2. Use the **Height** and **Width** fields to set the size of the widget. A 1 by 1 widget is the default and appears as a square on the Dashboard page, but you can input different values to change the size of the widget on the screen.
3. Select the **Show absolute and percentage change** checkbox if you want to display this data as an overlay within the widget. Select the **Use Green to indicate positive change** checkbox if you want to display this data in a green color when the data trends positive:
4. Select the **Display Previous Time Frame Data** checkbox to display additional data in the widget from a previous time frame of your choice, based on the time frame selected in Step 3 (Yesterday vs Same Day Last Week, etc).
5. Select the **Graph average based on all locations** checkbox if you want the widget to display an average of the data from all of your locations. This checkbox can only be selected if you follow the steps listed below the checkbox:
Select the **Show zero value events for drill-down** checkbox if you want to display "zero value" events (such as voids, no sale, etc) when you view the drill-down for a widget. You can access a widget drill-down by selecting [Summary view](/docs/understand-your-business/widget-configuration/widget-views.md) for a widget, then selecting a data point within the widget:
### Step 5: General Widget Settings
Fill out the following information:
1. Type a **Name** for the widget. The name appears near the top of the widget.
2. Select a **Tag**(s) for the widget. See [Widget Tags](/docs/understand-your-business/widget-configuration/dashboard-pages.md) for more information.
3. Type a **Description** of the widget (optional). Description text appears near the bottom of the widget when you hover over the widget.
4. Choose a visibility option for the widget:
* **Private**: The widget is only visible on the user account that created the widget.
* **Public**: The widget is visible to all Solink users within your company.
5. Choose whether to display this widget through [daily and/or weekly email digests](/docs/manage-users-locations-and-your-account/notifications.md).
**Note:** Daily and weekly widget digest notifications display a snapshot of widget data via email. If you wish to get a digest snapshot of widget data only when the data meets a certain value/percentage (for example, a certain revenue amount is achieved, a specific number of discounts have occurred, etc.,) See [**Threshold Notifications**](/docs/understand-your-business/widget-configuration/threshold-notifications.md) for more information.
6\. Select **Create Widget** to create the widget. It then appears on the **Dashboard** page.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://help.solink.com/docs/understand-your-business/create-widgets/report-widget.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.