> For the complete documentation index, see [llms.txt](https://docs.phocassoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.phocassoftware.com/basics/dashboards-new-experience/use-dashboards-new-experience.md).

# Use dashboards (new experience)

Dynamic, interactive, shared dashboards allow your team to monitor performance and collaboratively analyze the latest data changes.

{% hint style="info" %}
You are viewing documentation for the new dashboards experience.
{% endhint %}

{% embed url="<https://phocassoftware.wistia.com/s/7a6hvwr1ogln1fg>" %}
Use dashboards
{% endembed %}

The new dashboards experience works with [Flex Modes](https://docs.phocassoftware.com/flex-modes/) and Financial Statements.

When a dashboard is shared with you, your available actions depend on the permission level you receive:

* **Can view**: You can view the dashboard and see who it has been shared with.
* **Can edit**: You can view and edit the dashboard. You can also share it with other users.

## Find your way around a dashboard

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FTwLzwxLldFdCBmBqAZ64%2Fimage.png?alt=media&amp;token=b9973970-2126-4419-9223-6715bd33cca5" alt=""><figcaption></figcaption></figure></div>

{% tabs %}
{% tab title="1. Dashboard toolbar" %}
At the top, you can see the dashboard name.

Below that is the toolbar containing the following options:

* [**Focus**](#focus-on-a-widget-entity): Becomes active after you select a data item in an interactive widget. Click to filter out the other data.
* **Reset**: Becomes active after you change the period or apply a filter. Click to return the dashboard to its original state.
* [**Section**](#go-to-section): Jump to a specific section of the dashboard.
* [**Period**](#change-the-period): Change the time period of the data displayed on the dashboard.
* [**+ Add filter**](#add-a-filter): Add dropdown filters to refine the data displayed on the dashboard.
* [**Shared filters**](#share-filters-across-tabs): Turn on to keep this tab's filters in sync with other tabs that also have shared filters turned on, or turn off to apply filters to this tab only.
* [**Share**](#share-a-dashboard): Share the dashboard with other users.
* [**Subscribe**](#subscribe-to-a-dashboard): Subscribe to the dashboard to receive notifications on the configured schedule.
* [**Open notes**](#view-notes): View notes added by the creator or editors of the dashboard.
* [**Download**](#download-export-a-dashboard): Download the dashboard as a PDF file.
* [**Full screen**](#enter-full-screen-mode-dashboard): View the dashboard in full screen mode.
* **Mode** **(Viewing)**: Switch between view and edit modes.
  {% endtab %}

{% tab title="2. Sections" %}
Dashboards are organized into sections, with each section able to contain a number of widgets. Each section has a name, and might have a description.

You can use the **Go to section** option on the dashboard toolbar to quickly navigate between sections, or click the chevron next to the section name to collapse or expand the section.
{% endtab %}

{% tab title="3. Widgets" %}
Each section has one or more widgets containing a chart or grid.

When the same item, such as a Customer or Product, displays in multiple chart widgets, it displays as the same color in each chart, maintaining consistency across the dashboard.

When you hover over a widget, its toolbar displays. See [Interact with widgets](#interact-with-widgets) below.
{% endtab %}

{% tab title="4. Tabs" %}
Dashboards can contain a number of tabs, with each tab containing its own sections and widgets.

Click on a tab to open it, or select a tab from the menu.

The tab bar also shows the last build time of the databases used in the dashboard, in the bottom-right corner. See [Check when the data was last updated](#check-when-the-dashboard-data-was-last-updated) below.
{% endtab %}
{% endtabs %}

## Go to section

Use the **Section** menu to move around large dashboards.

Click **Section**, then select a section to jump directly to it.

## Check when the dashboard data was last updated

The tab bar at the bottom of the screen shows the last build time of the databases used in the dashboard, in the bottom-right corner. Use this to see at a glance how current the dashboard data is.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FsVBxzDNpDNgmg1EGhjNR%2Fimage.png?alt=media&amp;token=4706ceb7-1b70-467a-882f-6130a639b20b" alt="" width="407"><figcaption></figcaption></figure></div>

This information is also available in full screen mode, in the top-right corner.

## Change the period

The period selected for the dashboard determines the time and date range for the data displayed.

Use the **Period** menu to choose one of the following options:

* **Per widget** (default): Displays the period defined when each widget was created. This means widgets might show data from different time ranges.

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FProlTM2t0dGAFYO4Mwwx%2FPer%20widget%20period.png?alt=media&#x26;token=f9dedc24-65f2-48a8-993f-9cb60a1ef031" alt=""><figcaption><p>Example of the Per widget period option</p></figcaption></figure>

If you want to apply a single consistent period across all widgets on your dashboard, select one of the following options from the **Period** menu:

* **Select dates**: Specify a custom start and end date for the dashboard data, then click **Apply**. For instructions, see Flex Modes > Change the period > Apply a custom period.
* **Predefined**: Select one of the predefined periods available in the underlying database.

Clicking **Reset** will return the period to the default **Per widget** option.

## Filter a dashboard

There are several ways to filter the data on your dashboard to quickly hone in on the details you want to see.

{% embed url="<https://phocassoftware.wistia.com/s/q6955gl2md7msjn>" %}
Filter your dashboard
{% endembed %}

#### Add a filter

Use **+** **Add filter** to add dropdown filters to the dashboard. Filters allow you to narrow the displayed data by dimensions used in the dashboard, such as country, customer, sales representative, or product class.

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FdVGhTIyR0UHZlEQ3Bmbd%2Fimage.png?alt=media&#x26;token=ceb387c3-c6ff-4a52-b537-9761aa3ad57f" alt=""><figcaption></figcaption></figure>

1. Select **+** **Add filter**.
2. Search for a filter or select one from the **Used in this dashboard** list. The filter is added to the dashboard toolbar.
3. Open the filter and select one or more entities. Select **Select all** to include every entity. Widgets that are set as **Filterable** update accordingly.
4. Repeat these steps to add more filters as required.

A pin icon next to the filter name indicates that the filter is pinned for continued use. Open the filter and select:

* **Unpin filter** to keep the filter available only temporarily.
* **Remove filter** to remove it from the dashboard toolbar.

{% hint style="info" %}
Only compatible widgets that have **Filterable** turned on respond to the filter selections.
{% endhint %}

Click **Reset** to clear all selected entities and remove unpinned filters from the dashboard.

### Share filters across tabs

If your dashboard has multiple tabs, use shared filters to keep filters synchronized across every tab that also has shared filters turned on. This saves you from having to reapply the same filters each time you switch tabs while analyzing your data.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2F2sWYWDmnFxt948hGqLGb%2Fimage.png?alt=media&amp;token=63348a53-8299-4113-a239-44f2a593932a" alt="" width="533"><figcaption></figcaption></figure></div>

Click the **Shared filters** button (globe icon) in the dashboard toolbar, then choose:

* **Off (filter this tab only)**: Filters you apply on this tab apply only to this tab. Changes to filters on other tabs don't affect this tab, and changes on this tab don't affect other tabs.
* **On (replace this tab's filters with shared filters)**: This tab uses the same filters as every other tab that also has shared filters turned on. Adding, changing, or removing a filter on this tab updates the filters on those other tabs as well, and vice versa.

Shared filters is turned on by default when you add a new tab.

{% hint style="info" %}
Turning on shared filters for a tab replaces that tab's existing filters with the current shared filters.
{% endhint %}

### Focus on a widget entity

Select one or more entities in a widget and click **Focus** to show data for only those entities. This creates a filter that appears on the toolbar.

Click **Reset** to clear all filters on the dashboard.

## Share a dashboard

The **Share** button behaves differently depending on your permission level.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FyECKYdSZnrA3dOiqLBTS%2Fimage.png?alt=media&amp;token=2efc014d-605e-4576-aa2c-dbe18c3a388a" alt=""><figcaption></figcaption></figure></div>

* If the dashboard is shared with you with the **Can edit** permission, you can share it with other users.
* If you have **Can view** permission, you can't share the dashboard, but you can see who has access to it.

## Subscribe to a dashboard

Subscribe to a dashboard to receive an email containing a link to it on a regular schedule.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FqNab0Zs6c0ccZl5bOvXK%2Fimage.png?alt=media&amp;token=5eb65456-edc6-4a19-9832-076ad25c36b6" alt=""><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FVyy2v3MeJ30eFuNJEQOG%2Fimage.png?alt=media&#x26;token=aa1dabc0-b137-4cc5-bf14-0abe2b10b843" alt=""><figcaption></figcaption></figure></div>

1. Open the dashboard and select **Subscribe** in the dashboard toolbar.
2. Under **Schedule**, select how often you want to receive the dashboard:
   * **Monthly:** Receive it once a month. Select the required monthly delivery option.
   * **Weekly:** Receive it once a week. Select the day of the week.
   * **Daily:** Receive it every day.
3. Under **Delivery time**, select the time window in which you want the email to be delivered.
4. Optional: Select **Test** to test the subscription using the current settings.
5. Select **Save**.

The delivery method is **Email** and the delivery format is **Link**. Select **Cancel** to close the window without saving the subscription.

## View notes

The dashboard creator or editor might add notes to provide additional information or context.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FaM32D6hC41R3lZqWIRaM%2Fimage.png?alt=media&amp;token=1fa24be3-f572-411a-9021-816b5ba1d3b7" alt=""><figcaption></figcaption></figure></div>

1. Click **Open notes**. The **Notes** panel opens.
2. Read the notes.
3. Click **X** to close the panel.

## Download a dashboard

Download a dashboard as a PDF that captures the dashboard as it currently appears, including its layout and widgets. You can customize the footer and include other dashboard tabs, which are added as separate pages in the PDF.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FwuoPwrypuRQoogjicUfN%2Fimage.png?alt=media&amp;token=d5d6ef61-ed71-4aff-ad5f-512b041f5fde" alt=""><figcaption></figcaption></figure></div>

1. Click the **Download** button.
2. Under **Footer**, select what you want to display on the left and right of the page. Choose from the default options, including the created date, Phocas branding, page number, and confidentiality or legal notices, or add your own custom text.
3. Under **Tabs**, select any additional tabs you want to include. The current tab is selected by default and can't be cleared. Each additional tab is added as a separate page in the PDF.
4. Click **Download**.

The PDF is saved to your default downloads folder.

{% hint style="success" %}
**Want to choose the file name?**

You can't customize the file name in Phocas, but your browser settings might allow you to choose it when you download the file. [Learn how](https://support.pdfarchitect.org/hc/en-us/articles/7264830967060-How-to-change-my-browser-settings-to-name-files-as-I-save-them)
{% endhint %}

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2Fgit-blob-ba7601641138f0b0024a8b4619a4586e58ab8024%2Fimage%20(753).png?alt=media" alt=""><figcaption><p>Downloading a dashboard to a PDF</p></figcaption></figure>

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2Fgit-blob-589e9dc08f5e075302bcb5e56ac75391b8c3bbd9%2Fimage%20(752).png?alt=media" alt=""><figcaption><p>The PDF matches the dashboard as it appears in Phocas</p></figcaption></figure>

{% hint style="info" %}
If a grid contains more rows than fit in the available space, the PDF displays the rows that fit and groups the remaining rows into **Others**.
{% endhint %}

## Enter full screen mode

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FPBWFC2gqDZfmZF2RARHA%2Fimage.png?alt=media&amp;token=c2f237f0-f2ca-4d3b-9ffa-31779ed40418" alt=""><figcaption></figcaption></figure></div>

Click the **Full screen** button to enter full screen mode. This will hide the browser toolbar and all Phocas navigation.

This view is great for presenting, or for displaying dashboards on a dedicated screen, for example, as a hand-off dashboard on a large screen or device.

When in full screen mode, a simplified filtering toolbar is available, and can be expanded by clicking the **Show filters** button in the top right of the screen.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FXkhv4BOlCCWs15LN5ZOA%2FFullscreen%20options_menu_expand.png?alt=media&#x26;token=12128c48-8ed1-41d0-8e9d-b8094beba1b5" alt="" width="242"><figcaption></figcaption></figure></div>

#### Configure full screen display options

Click the **Full screen settings** button, in the top right of the screen, to open the full screen display options.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FFsCcbOpPCDN4Mty7r2Z8%2FFullscreen%20options_menu_settings.png?alt=media&#x26;token=c8cc61b7-800a-4483-abcc-c67b2461d6b9" alt="" width="242"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FKptLT65UNRROXZiVCh6D%2Fimage.png?alt=media&#x26;token=dc1d4e86-5e9a-4968-83e5-3179ff5c222b" alt=""><figcaption><p>Full screen display options</p></figcaption></figure></div>

**Fit mode**: Choose how widget content displays on the page.

* **Actual size - tab**: Widgets display at their normal size. If content is taller than the screen, you will need to scroll.

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FoWPZsh9rRoMRuSGuEpNe%2Fimage.png?alt=media&#x26;token=49b8dacb-4e0d-4e53-96f1-14c1efa3706f" alt=""><figcaption><p>Actual size - tab</p></figcaption></figure>

* **Actual size - section:** Widgets display at their normal size, one section at a time. This is useful for sections with tall widgets, such as grids and graphs, that you want to display in full. Turn on **cycling** to automatically move through each section.

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FViqGztxdFD5z4aMDSyH6%2Fimage.png?alt=media&#x26;token=cc9dd181-80b3-45d5-bfc0-39a2d4149db8" alt=""><figcaption><p>Actual size - section with cycling on</p></figcaption></figure>

* **Fit tab**: Widget content automatically increases or decreases in height so everything fits on the page without scrolling. This helps prevent content from being cut off when you display the dashboard on different screen sizes.

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FeQTZlq3R2JghWenxEpyc%2Fimage.png?alt=media&#x26;token=a781e44e-1fc0-4afc-8138-f279c2a4fdb4" alt=""><figcaption><p>Fit tab</p></figcaption></figure>

These display options are particularly useful for dashboards displayed unattended on shared screens. You can fit more content on the screen and automatically cycle through sections or tabs without anyone needing to click through them.

* **Cycling**: Automatically cycle through sections or tabs at a set interval. Select **10s**, **30s**, **1 min**, **2 min**, or **5 min** to turn on cycling. It is off by default.
* **Compact header**: Turn on to reduce the height of the dashboard header and give more screen space to widget content.

Click the **Exit full screen mode** button to return to the standard dashboard view.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FZ96XEWFCc0LeB1Jksiy2%2FFullscreen%20options_menu_exit.png?alt=media&#x26;token=7b3409b3-43c3-40b9-8c87-4d8474959c0f" alt="" width="242"><figcaption></figcaption></figure></div>

## Switch to edit mode

If the dashboard is shared with you with **Can edit** permission, you can edit it.

See [Edit a dashboard (new experience)](/basics/dashboards-new-experience/create-a-dashboard.md) to learn how to switch between view and edit modes and make changes to a dashboard.

## Interact with widgets

Hover over a widget to show its toolbar. Available options vary by widget type. Items available in the widget toolbar will change depending on the widget type.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FbR9bVLUgIGWJJTQsrP14%2FWidget%20toolbar.png?alt=media&#x26;token=355fca3c-d4d7-4a0c-b885-3eece399f8ec" alt=""><figcaption><p>Widget toolbar</p></figcaption></figure></div>

### View the underlying data

Available for chart widgets. Click ![](https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2Fgit-blob-877080679f364c7606ef304be3df39dcdf46090f%2Fimage%20\(632\).png?alt=media) **Show grid** to switch the widget to the underlying grid data.

The grid updates automatically when you apply focus or filters to the widget.

{% hint style="success" %}
When viewing the grid, use full screen mode to view more rows and see all the data.
{% endhint %}

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2Fgit-blob-6d534aea7436b4565d6bef30baf68959be722a81%2Fimage%20(617).png?alt=media" alt=""><figcaption><p>Switch between chart and grid views</p></figcaption></figure>

### Analyze the data

Click ![](https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2Fgit-blob-17d10f0848068f8ca071cafdb5b89b5d740b706c%2Fimage%20\(633\).png?alt=media) **Analyze** to open the widget's underlying data in Flex Modes.

From there, you can view the data used to create the widget and perform further analysis.

This usually opens in a new browser window. You must have permission to access the data

<figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2F3Gf6mnzbktpwpeZJUyIQ%2FAnalysis%20diagram.png?alt=media&#x26;token=3c5fe71c-da0c-41f1-acaf-96a18c23c3a5" alt=""><figcaption><p>Click Analyze on a widget to view the underlying data in Flex Modes</p></figcaption></figure>

### Download a widget

Available for chart widgets. Click ![](https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2Fgit-blob-0353f35d9bfbfee4aeabf2ea2e8aaf9e4d8d5055%2Fimage%20\(634\).png?alt=media) **Download** to download the chart as an SVG file for use elsewhere.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FYT2fbjlHn11sLaUMaAVq%2Fwidget%20download.png?alt=media&#x26;token=775b34d2-5c55-4b03-a917-895bbe9b9412" alt=""><figcaption><p>Download a widget</p></figcaption></figure></div>

### View a widget in full screen

Click ![](https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2Fgit-blob-f35440ab11352f163ab2f1c78513f3b55d63344c%2Fimage%20\(635\).png?alt=media) **Enter full screen** to view it in full screen mode.

This hides the browser toolbar and Phocas navigation, so you can focus on a single widget. This is useful for presenting or displaying a widget on a dedicated screen.

When in full screen mode, a toolbar is available at the bottom:

* Click **Start auto play** to begin a slideshow of the widgets on the dashboard.
* Click the button again to pause the slideshow.
* Use **Previous** and **Next** to move between widgets.

### Select a widget segment

Widgets on a dashboard are connected. When you select an entity in one widget (for example, a segment in a pie chart), it's highlighted across all related widgets. This helps you follow the same data point and see patterns and relationships across the dashboard. Each entity uses a consistent color across widgets, and colors remain stable when filtering.

Select a segment or data point in a widget to highlight that entity across all related widgets. Select it again to clear the selection.

<div align="left"><figure><img src="https://900295827-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7pj8v25BOyqZTdG5mdD1%2Fuploads%2FMSkFfL4ETiS3Y1QUCcXx%2FFiltered%20charts.png?alt=media&#x26;token=86d75a60-d05b-4b6c-b6ac-461f4c64e9d9" alt=""><figcaption><p>Selected chart segments are highlighted across all widgets that the selected entity appears in</p></figcaption></figure></div>


---

# 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://docs.phocassoftware.com/basics/dashboards-new-experience/use-dashboards-new-experience.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.
