The DynamicReportFilter method retrieves the default filter syntax of a Dynamic Report. The filter syntax can be used as part of a DynamicReport method request.
The DynamicReportFilter method is invoked using the MethodOperation.
Name | Type | Description |
---|---|---|
reportName | String | Required. This is the name of the Dynamic Report. |
The following example retrieves the filter syntax for the Dynamic Report named A - Clients By City.
Request XML
<request version='1.0'> <header> <office>myoffice</office> <user>jdoe</user> <password>password</password> </header> <method> <DynamicReportFilter> <reportName>A - Clients By City</reportName> </DynamicReportFilter> </method> </request>
Response XML
<response version="1.0"> <header> <sessionClosed/> </header> <method> <DynamicReportFilter> <![CDATA[ <filter fltrkey="1"> <filter fltrkey="2"> <systemFilter fltrkey="3" fltrnm="Postal Address" id="address-contact" sqlop="eq"> <filter fltrkey="2"> <element colName="City" colid="393223" fltrkey="3" sqlop="eq" value="Los Angeles"/> </filter> </systemFilter> </filter> <filter fltrkey="3"> <element colName="Type" colid="65627" fltrkey="5" sqlop="eq" value="Client"/> <element colName="Sub-Type" colid="65541" fltrkey="6" sqlop="eq" value="A"/> </filter> </filter> ]]> </DynamicReportFilter> </method> <_status>OK</_status> <!--Cost 49 mill seconds.--> </response>
When modifying a filter in which sqlop="popular dates", refer to the following table for the correct date range value.
Date Range | Value |
---|---|
Current | |
Today | 32 |
Current Week | 27 |
Current Month | 0 |
Current Quarter | 2 |
Current Year | 1 |
Previous | |
Yesterday | 30 |
Previous 7 Days | 22 |
Previous 15 Days | 33 |
Previous 30 Days | 21 |
Previous 60 Days | 34 |
Previous 90 Days | 88 |
Previous Week | 25 |
Previous 2 Weeks | 35 |
Previous Month | 3 |
Previous 2 Months | 36 |
Previous 3 Months | 6 |
Previous 6 Months | 7 |
Previous 9 Months | 8 |
Previous 12 Months | 9 |
Previous Quarter | 5 |
Previous Year | 4 |
Previous 2 Years | 37 |
Previous 180 Days | 74 |
Previous 360 Days | 75 |
All Events in Past | 28 |
Next | |
Tomorrow | 31 |
Next 7 Days | 24 |
Next 15 Days | 38 |
Next 30 Days | 23 |
Next 60 Days | 39 |
Next Week | 26 |
Next 2 Weeks | 40 |
Next Month | 14 |
Next 2 Months | 41 |
Next 3 Months | 17 |
Next 6 Months | 18 |
Next 9 Months | 19 |
Next 12 Months | 20 |
Next Quarter | 16 |
Next Year | 15 |
Next 2 Years | 42 |
Next 180 Days | 76 |
Next 360 Days | 77 |
All Events in Future | 29 |
Before | |
Before 7 Days | 54 |
Before 15 Days | 55 |
Before 30 Days | 56 |
Before 45 Days | 72 |
Before 60 Days | 57 |
Before 2 Weeks | 58 |
Before 1 Month | 48 |
Before 2 Months | 49 |
Before 3 Months | 50 |
Before 6 Months | 51 |
Before 9 Months | 52 |
Before 12 Months | 53 |
Before 1 Year | 46 |
Before 2 Years | 47 |
After | |
Beginning in 7 Days | 67 |
Beginning in 15 Days | 68 |
Beginning in 30 Days | 69 |
Beginning in 45 Days | 73 |
Beginning in 60 Days | 70 |
Beginning in 2 Weeks | 71 |
Beginning in 1 Month | 61 |
Beginning in 2 Months | 62 |
Beginning in 3 Months | 63 |
Beginning in 6 Months | 64 |
Beginning in 9 Months | 65 |
Beginning in 12 Months | 66 |
Beginning in 2 Years | 60 |
Quarter | |
1st Quarter This Year | 10 |
2nd Quarter This Year | 11 |
3rd Quarter This Year | 12 |
4th Quarter This Year | 13 |
Quarter Last Year | |
1st Quarter Previous Year | 78 |
2nd Quarter Previous Year | 79 |
3rd Quarter Previous Year | 80 |
4th Quarter Previous Year | 81 |
To Date | |
Week-to-Date | 82 |
Month-to-Date | 43 |
Quarter-to-Date | 44 |
Year-to-Date | 45 |