# ReportParameterDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

A filter a report accepts in the `filters` object of a run.

## Fields
- `name` (string): The key to send the filter under in `filters`. Stable once published. (nullable)
- `label` (string): The filter's display label. (nullable)
- `type` (string): The value type: `bool` takes `true` or `false`, `int` takes a whole number,  `enum` takes one of `options`, and any other type takes a string. (nullable)
- `isRequired` (boolean): Whether the report needs the filter to run.
- `allowMultiple` (boolean): Whether the filter takes an array of values rather than a single value.
- `helpText` (string): A short explanation of the filter, when the report provides one. (nullable)
- `defaultValue` (string): The value the report uses when the filter is not sent, as text, when it has one. (nullable)
- `options` (array<[ReportParameterOptionDto](https://devportal.demo.winkpg.io/docs/api/models/ReportParameterOptionDto.md)>): The allowed values, for a filter that takes one of a fixed set. (nullable)
  Fields of each item:
  - `value` (string): The value to send. (nullable)
  - `display` (string): The value's display text. (nullable)

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.