Adding a parameter is simple—just use the format {{parameter_name}} in your queries or scripts.
For example, if you want to retrieve total sales within a specific date range, you can use:
“Show me all sales from the start date as {{start_date}} and the end date as {{end_date}}.”
Clicking the three dots provides options to set additional rules for managing these parameters, as well as customizing responses when those rules are not met.
See below an example of a test run – with the Method being POST
You can seamlessly switch between different HTTP (POST, GET, PUT, DELETE) methods by selecting the desired option from the Method dropdown. The available parameters will automatically adjust based on the selected method, ensuring a smooth and efficient configuration process.
Additional Parameters –
In addition to user-defined parameters, Silverline API includes certain reserved parameters that facilitate seamless data integration and processing.
The {{queryResultset}} parameter holds the response of queries from the Data Analysis and Query Setup tab. This parameter is essential when working in the Script Setup tab, as it allows scripts to access and process the combined query results. If a script requires query responses, this parameter should be referenced to ensure proper data flow.
The {{scriptResponse}} parameter stores the output of an executed script in the Script Setup tab and can be used within queries in the Data Analysis and Query Setup tab. This enables queries to leverage script-generated data, creating a more dynamic and flexible data integration process.
The {{QueryID:<ID>:<Column_Name>}} parameter is specifically used in multi-data source scenarios where queries from different data sources need to be connected. It ensures that key columns from one query are passed into another, allowing seamless cross-source data retrieval. For a deeper understanding of its usage, refer to the Multi-Data Source documentation, which provides detailed examples and best practices.
The {{token.<variable>}} parameter allows the use of specific claims from the authentication token within queries or scripts. This is particularly useful for restricting outputs to only the rows or datasets permitted for the authenticated user. Additionally, it can be leveraged for implementing row-level security.
