> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-agentix/detect-investigate-and-respond-to-threats/monitor-dashboards-and-reports/advanced-configuration/create-custom-widgets/add-parameters-to-a-custom-xql-widget.md).

# Add parameters to a custom XQL widget

If you want to use filters and drilldowns on your dashboard, one or more widgets on the dashboard must contain parameters. For more information about filters and drilldowns, see [Configure global filters](/cortex-agentix/detect-investigate-and-respond-to-threats/monitor-dashboards-and-reports/advanced-configuration/configure-global-filters.md) and [Configure drilldowns](/cortex-agentix/detect-investigate-and-respond-to-threats/monitor-dashboards-and-reports/advanced-configuration/configure-drilldowns.md).

Parameters can be static or dynamic, and support single or multi-select values.

{% stepper %}
{% step %}
**Create an XQL widget.**
{% endstep %}

{% step %}
**Define an XQL query and click Preview.**

You can base your filters on fields and values in the query results.
{% endstep %}

{% step %}
**Add parameters to the query using the filter stage, define parameters prefixed with `$`.**

* **For single select filters:** `filter <field> = &<parameter>`

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Example:</strong><br>This filter enables dashboard users to filter the dashboard by a single predefined severity value.</p><p><code>filter xdm.issue.severity = &#x26;severity)</code></p></div>
* **For multi select filters:** `filter <field> in(&<parameter>)`

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Example:</strong><br>This filter enables dashboard users to filter the dashboard by one or more domain values (predefined or dynamically generated).</p><p><code>filter domain in(&#x26;domain)</code></p></div>

{% endstep %}

{% step %}
**(Optional) Under Parameters, define default values for your query parameters.**

This makes the widget populate automatically on load. You can also define default values when configuring filters in the dashboard or report builder, or leave this blank.
{% endstep %}
{% endstepper %}


---

# 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 dynamically by asking a question.

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

```
GET https://cortex-docs.paloaltonetworks.com/cortex-agentix/detect-investigate-and-respond-to-threats/monitor-dashboards-and-reports/advanced-configuration/create-custom-widgets/add-parameters-to-a-custom-xql-widget.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
