URL Aware Text-Based Filters on Reports via REST API

Overview

This article demonstrates how to implement text-based filters on Reports as a URL parameter for a service API call. The URL generated on the Integration Details page of the Report has "contains.value=" at the end, which can be used to filter the Report by providing a filterable parameter after the = symbol. This example uses a Report populated with Account data from the Decisions environment. 

Example:

1. In a Designer Project, select the CREATE REPORT button from the top panel.
2. Select the large Report tile on the left and provide a name, then select CREATE.
3. In the Report Designer, in the Data Sources column, expand Common and add Account Data Source.'
4. In this example, add Account Id, Email Address, and Account Type for the Data Fields.
5. Next, add the Email Address Contains Filter from Field Filters > Email Adress > Email Address Contains.
6. With this Filter selected, navigate to the Properties that appear on the right. 
7. Chose the Runtime Editable option from Runtime Behavior dropdown. Select the checkbox labeled Show all data when filter value empty so that Report data will populate even without filter criteria.
   
8. Click into some gray area in the panels above to populate the base Report properties. 
9. Locate the SERVICE SETTINGS section and change the Integration Type to API Service. 
10. Change the Data Format to XML.
11. Save and close the Report once complete.
    
12. Back in the Designer Project, right-click the name of the Report and navigate to Run [Advanced] > Integration > View Integration Details in the Action Menu.
    
13. On the Integration Details Page, keep the Authentication Type set to Login and select Download Postman Collection to reveal the URLs.
14. Copy the Call via GET URL to the clipboard.
    
15. Paste the generated URL into the browser and navigate to the address so that the service call delivers the Report in XML.
16. Notice that "Contains.Value=" does not have a value at the end, which is why the entire Report appears. 
    
17. Enter any value contained in an email address from an account in the Decisions after the = symbol so that the specified, filter-based results appear.