> 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/event-ticker-widget.md).

# Event Ticker Widget

You can use an **Event Ticker** widget to track data in real-time at the bottom of the Dashboard page. This is helpful if you want to track real-time transactions as they occur, for instance:\
​

<img src="https://1562067156-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlMN1EUQcXYfv7FYpGJWR%2Fuploads%2Fgit-blob-baccfc805a88a8f357771390f15feef7f4071d85%2F285b0e279498a48c.gif?alt=media" alt="" width="560">

To create an **Event Ticker** 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)

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.

### Step 4: Graph Visuals and Comparison Settings

Configure the following graph visuals and comparison settings:

1. Type any number of **Highlight Words**. Each word you enter appears highlighted in the event ticker whenever the word appears (for example, if you type "Refund" as a Highlight Word, if the word "Refund" appears in the event ticker it will be highlighted in a separate color.).
2. Select the **Show zero value events** checkbox if you want to display "zero value" events (such as voids, no sale, etc) in the event ticker.

### 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. Type a **Description** of the widget (optional). Description text appears near the bottom of the widget when you hover over the widget.
3. 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/event-ticker-widget.md?ask=<question>&goal=<user_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.