{"id":27139,"date":"2026-02-09T15:24:23","date_gmt":"2026-02-09T14:24:23","guid":{"rendered":"https:\/\/docs.reybex.com\/?post_type=manual_documentation&p=27139"},"modified":"2026-02-09T15:26:44","modified_gmt":"2026-02-09T14:26:44","slug":"bas23-dataexportfeed-api-filter-parameters","status":"publish","type":"manual_documentation","link":"https:\/\/docs.reybex.com\/en\/dokumentation\/bas23-dataexportfeed-api-filter-parameters\/","title":{"rendered":"BAS23 DataExportFeed API \u2013 Filter Parameters"},"content":{"rendered":"\n

This document describes the filter parameters used by the GET \/api\/dataExportFeed<\/code> endpoint and the two supported filter formats.<\/p>\n\n\n\n

Base URL:<\/strong>
\/api\/dataExportFeed?feedToken=<feedToken><\/code><\/p>\n\n\n\n

feedToken<\/code> is required. Filters are optional.<\/p>\n\n\n\n

\n\n\n\n

1. Simple Filter Format<\/h2>\n\n\n\n

Use this format to apply filters via the standard Kendo filter structure. The filter<\/code> query parameter is parsed on the server and converted into Kendo grid format.<\/p>\n\n\n\n

Syntax<\/h3>\n\n\n\n
filter=<field>:<operator>:<value><\/code><\/pre>\n\n\n\n
For multiple conditions, separate with commas. All conditions are combined with AND<\/strong> logic.<\/p>\n\n\n\n
filter=<field1>:<op1>:<value1>,<field2>:<op2>:<value2><\/code><\/pre>\n\n\n\n
Examples<\/h3>\n\n\n\n
Purpose<\/th>Example URL parameter<\/th><\/tr><\/thead>
lastModified<\/code> after 01.01.2022<\/td>filter=lastModified:gt:01.01.2022<\/code><\/td><\/tr>
Equality<\/td>filter=status:eq:ACTIVE<\/code><\/td><\/tr>
Less than or equal<\/td>filter=amount:lte:100<\/code><\/td><\/tr>
Text contains<\/td>filter=name:contains:test<\/code><\/td><\/tr>
Multiple filters<\/td>filter=lastModified:gt:01.01.2022,status:eq:ACTIVE<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Field mapping<\/h3>\n\n\n\n
    \n
  • In the URL you can use the DataExport column name<\/strong> (display name).<\/li>\n\n\n\n
  • The server maps name \u2192 code<\/strong> using the DataExport\u2019s items<\/code> (DataExportItem). The query uses the code<\/strong>.<\/li>\n\n\n\n
  • If no mapping exists, the value is used as-is (as code).<\/li>\n<\/ul>\n\n\n\n
    Supported operators<\/h3>\n\n\n\n
    Operator<\/th>Description<\/th><\/tr><\/thead>
    eq<\/code><\/td>Equals<\/td><\/tr>
    neq<\/code><\/td>Not equal<\/td><\/tr>
    gt<\/code><\/td>Greater than<\/td><\/tr>
    gte<\/code><\/td>Greater than or equal<\/td><\/tr>
    lt<\/code><\/td>Less than<\/td><\/tr>
    lte<\/code><\/td>Less than or equal<\/td><\/tr>
    contains<\/code><\/td>Contains (text)<\/td><\/tr>
    doesnotcontain<\/code><\/td>Does not contain<\/td><\/tr>
    startswith<\/code><\/td>Starts with<\/td><\/tr>
    endswith<\/code><\/td>Ends with<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Example request<\/h3>\n\n\n\n
    GET \/api\/dataExportFeed?feedToken=...&filter=lastModified:gt:01.01.2022<\/code><\/pre>\n\n\n\n
    On the server this is converted to standard Kendo filter parameters (field, operator, value, and logic).<\/p>\n\n\n\n
    \n\n\n\n
    2. Advanced Filter Format (advancedFilter)<\/h2>\n\n\n\n
    Some DataExport feeds use queries where filters must be applied at the data layer. In those cases use the advancedFilter<\/strong> format so the server can apply filters correctly.<\/p>\n\n\n\n
    When to use<\/h3>\n\n\n\n
      \n
    • When the feed runs a query where filters need to be applied in the backend.<\/li>\n\n\n\n
    • For date-range filters (startDate\/endDate) or single value filters (value) in that context.<\/li>\n<\/ul>\n\n\n\n
      Simple string format (query param advancedFilter<\/code>)<\/h3>\n\n\n\n
      You can pass a single query parameter advancedFilter<\/code> instead of multiple filter[filters][n][advancedFilter][...]<\/code> params. The server parses it into the same advancedFilter structure.<\/p>\n\n\n\n
      Format:<\/strong><\/p>\n\n\n\n
        \n
      • Single value: field:value<\/code><\/li>\n\n\n\n
      • Date range: field:startDate:endDate<\/code><\/li>\n\n\n\n
      • Multiple filters: comma-separated, e.g. field1:value1,field2:value2<\/code> or field1:start:end,field2:value<\/code><\/li>\n<\/ul>\n\n\n\n
        Examples:<\/strong><\/p>\n\n\n\n
        URL (relevant part)<\/th>Result<\/th><\/tr><\/thead>
        advancedFilter=lastModified:2025-08-01<\/code><\/td>One filter: field=lastModified, value=2025-08-01<\/td><\/tr>
        advancedFilter=lastModified:2025-01-01:2025-08-01<\/code><\/td>One filter: field=lastModified, startDate, endDate<\/td><\/tr>
        advancedFilter=lastModified:2025-08-01,status:ACTIVE<\/code><\/td>Two filters (index 0 and 1)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
        Example request:<\/strong><\/p>\n\n\n\n
        GET \/api\/dataExportFeed?feedToken=...&advancedFilter=lastModified:2025-08-01<\/code><\/pre>\n\n\n\n
        This is equivalent to passing filter[filters][0][advancedFilter][field]=lastModified&filter[filters][0][advancedFilter][value]=2025-08-01<\/code>.<\/p>\n\n\n\n
        Full syntax (explicit params)<\/h3>\n\n\n\n
          \n
        • Field:<\/strong>
          filter[filters][<index>][advancedFilter][field]=<columnTitle><\/code><\/li>\n\n\n\n
        • Value (text or single date):<\/strong>
          filter[filters][<index>][advancedFilter][value]=<value><\/code><\/li>\n\n\n\n
        • Date range:<\/strong>
          filter[filters][<index>][advancedFilter][startDate]=<date><\/code>
          filter[filters][<index>][advancedFilter][endDate]=<date><\/code><\/li>\n<\/ul>\n\n\n\n
          <index><\/code> is a zero-based integer (0, 1, 2, \u2026). Use the same index for all parts of one filter.<\/p>\n\n\n\n
          Examples<\/h3>\n\n\n\n
          Single field, single value:<\/strong><\/p>\n\n\n\n
          filter[filters][0][advancedFilter][field]=lastModified\nfilter[filters][0][advancedFilter][value]=2025-08-01<\/code><\/pre>\n\n\n\n
          Full URL example:<\/strong><\/p>\n\n\n\n
          GET \/api\/dataExportFeed?feedToken=...&filter[filters][0][advancedFilter][field]=lastModified&filter[filters][0][advancedFilter][value]=2025-08-01<\/code><\/pre>\n\n\n\n
          Date range:<\/strong><\/p>\n\n\n\n
          filter[filters][0][advancedFilter][field]=lastModified\nfilter[filters][0][advancedFilter][startDate]=2025-01-01\nfilter[filters][0][advancedFilter][endDate]=2025-08-01<\/code><\/pre>\n\n\n\n
          Second filter (different index):<\/strong><\/p>\n\n\n\n
          filter[filters][0][advancedFilter][field]=lastModified\nfilter[filters][0][advancedFilter][value]=2025-08-01\nfilter[filters][1][advancedFilter][field]=status\nfilter[filters][1][advancedFilter][value]=ACTIVE<\/code><\/pre>\n\n\n\n
          Backend behaviour<\/h3>\n\n\n\n
            \n
          • field<\/code>:<\/strong> Must match the column title from the feed\u2019s metadata (tableSettings \/ columnTitle). The server maps these to the underlying query.<\/li>\n\n\n\n
          • value<\/code>:<\/strong> Used for text or single-date filters. Only columns marked as isAdvancedSearchable<\/strong> in the feed metadata are applied.<\/li>\n\n\n\n
          • startDate<\/code> and endDate<\/code>:<\/strong> For date\/datetime columns, used together to apply a date-range filter.<\/li>\n<\/ul>\n\n\n\n
            Parameter summary<\/h3>\n\n\n\n
            Parameter<\/th>Description<\/th><\/tr><\/thead>
            filter[filters][n][advancedFilter][field]<\/code><\/td>Column to filter (metadata columnTitle).<\/td><\/tr>
            filter[filters][n][advancedFilter][value]<\/code><\/td>Filter value (text or single date).<\/td><\/tr>
            filter[filters][n][advancedFilter][startDate]<\/code><\/td>Start of date range.<\/td><\/tr>
            filter[filters][n][advancedFilter][endDate]<\/code><\/td>End of date range.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
            \n\n\n\n
            3. Which format when?<\/h2>\n\n\n\n
            Scenario<\/th>Recommended format<\/th><\/tr><\/thead>
            Standard Kendo-style filtering (default pipeline)<\/td>Simple:<\/strong> filter=field:op:value<\/code><\/td><\/tr>
            Feed where filters are applied in the backend query<\/td>advancedFilter<\/strong> with field<\/code>, value<\/code>, and optionally startDate<\/code>\/endDate<\/code><\/td><\/tr>
            Date range filter<\/td>advancedFilter<\/strong> with startDate<\/code> and endDate<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
            \n","protected":false},"author":35,"featured_media":0,"parent":0,"menu_order":0,"template":"","manualdocumentationcategory":[8770],"_links":{"self":[{"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/manual_documentation\/27139"}],"collection":[{"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/users\/35"}],"version-history":[{"count":2,"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/manual_documentation\/27139\/revisions"}],"predecessor-version":[{"id":27144,"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/manual_documentation\/27139\/revisions\/27144"}],"wp:attachment":[{"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/media?parent=27139"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/docs.reybex.com\/en\/wp-json\/wp\/v2\/manualdocumentationcategory?post=27139"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}