Summary
Most of the REST API endpoints support getting reports with a reference parameter set.
When getting a REST API report with a reference parameter set, you don't have to provide all of the required report parameters. You just provide the ID of the reference parameter set. The report will be prepared using the parameters saved in the parameter set.
Please see the parameters list of each REST API endpoint for details on using a reference parameter set value.
Overriding Values
Any other report parameters you send in the request will override the parameter with the same name in the parameter set. In other words, the parameter values you provide explicitly have priority from the values inferred from the parameter set.
This enables great flexibility while getting REST API reports with parameter sets.
Using a Parameter Set on Different REST API Endpoints
The exact output of a parameter set might change based on the endpoint. And sometimes you might need to provide additional parameters.
For example, when a parameter set that was saved for a "List" report is used on a REST endpoint that provides "Aggregated" reports, the system will prepare an aggregation report using the parameters in the set and expect you to provide the "aggregationType" parameter. Similarly, when a parameter set that was saved for an "Average" report is used on a REST endpoint that provides "List" reports, the system will ignore the parameters about average calculations and prepare a "List" report.
Getting Details about Saved Parameter Sets
To see all saved parameter sets and their IDs, use the /reportSettings endpoint.
To see the details of a single parameter set, use the /reportSettings/<param_set_id> endpoint.