← All native models

Native model

report_parameter

Declare a named report_parameter value and reference it as report_parameter.your_name. Models have no separate platform identity or lifecycle.

Topics: ReportsReporting

Fields

One input the report asks for when it runs, such as a date range or a customer.

object
defaultValueOptional
entityPrefixOptional

For ENTITY parameters: the TypeID prefix the value must have.

string
labelRequired

Label shown to the person running the report.

string
nameRequired

Name used in queries and templates: a letter followed by letters, digits or underscores.

string
optionsOptional
requiredRequired

Set to true if the report cannot run without this value.

boolean
typeRequired

Kind of value. ENTITY expects the TypeID of a record.

string
Allowed values
["STRING","INTEGER","NUMBER","BOOLEAN","DATE","DATETIME","ENTITY"]

Only the fields listed here are accepted.