Skip to content

Parameters

Parameters enable dynamic reports that can be filled with different values on each invocation.

The entire application uses one unified parameter syntax: {{param.name}}

ContextSyntaxExample
SQL Query{{param.name}} or :nameWHERE country = {{param.country}}
REST Path/Body{{param.name}}/api/sales?country={{param.country}}
GraphQL Variables{{param.name}}{"code": "{{param.continent}}"}
Text Panels{{param.name}}Report for {{param.country}}
Filename Template{{param.name}}Revenue {{param.country}}.pdf

In SQL, :name is accepted as a JDBC-compatible alternative. The backend internally converts {{param.name}} to PreparedStatement parameters.

Reports define their parameters in the designer under the report properties:

  • Name — Technical name (referenced in {{param.name}})
  • Type — Data type of the parameter
  • Default Value — Optional default value

The defined parameters are:

  • Shown as input fields in the report designer
  • Resolved in text panels via {{param.name}}
  • Passed to data sets (SQL, REST, GraphQL)
  • Resolved in the filename template

When exporting a PDF, parameters can be passed as URL query parameters:

GET /api/reports/{id}/pdf?country=Germany&month=June

Parameters not provided fall back to their default values.

This also applies to share links:

GET /api/public/share-links/{token}/pdf?country=Germany

In the data set detail view, parameters are automatically detected from the query text (both {{param.name}} and :name in SQL). For each detected parameter, an input field appears above the Run button, allowing you to test the query ad-hoc.

In the report list and the deploy drawer, PDF links can be copied. The links automatically include the default values of the report parameters:

/api/reports/{id}/pdf?environment={envId}&country=Germany&month=June