{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/process-intelligence-apis/knowledge-model-api/features/filtering/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Filtering

\n

Filtering allows API consumers to only retrieve the desired records and not the whole data set. There are two ways to filter the data returned by the /data endpoint.

\n

Predefined Knowledge Model Filters

\n
    \n
  1. \nApply filters pre-defined in the Knowledge Model by using the \nfilters\n query parameter. \n
    \n\n\nFilters:\n A comma-separated list of filter ids.\n\n \n
    \n\n\n
    \n\n\nNote that:\n\n
    2. \n
\n

Examples:

\n
\n
\n
Copy
\n
Copied
\n
\n 
filters=not_null_orders,delayed_orders or filters=not_null_orders&filters=delayed_orders
\n
\n

Ad-hoc Filter Expressions

\n
    \n
  1. \nFilter expression using the \nfilterExpr\n query parameter.\n
    \n\n\nThis parameter allows filtering of record data using a provided value of a field through an expression.\n
    2. \n
\n

Legacy Filter Expressions

\n
    \n
  1. \nFirst pattern field operator value where:\n\n* \nfield\n is a filterable attribute, augmented attribute or flag of a record. \nThis value is case-sensitive and should be equal to the attribute id.\n\n* \noperator\n is a comparison operator. For this pattern, it is currently supported by following operators:\n* \neq(=), gt(>), lt(<), ne(!=), ge(>=), le(<=), is(IS) and in(IN)\n\n* \nvalue\n is a constant, such as a Salesforce Opportunity ID or a number/text.\n
      \n
    1. \nSecond pattern operator(field,value) where:\n
        \n
      • \noperator\n is a string search operator,similar to the LIKE in the SQL clause. For this pattern, it is currently supported by following operators:\n
          \n
        • \nstartswith, endswith and contains\n
          • \n
        \n
        • \n
      \n
      2. \n
    \n
    2. \n
\n

It is also possible to combine filters with logical operators and, or, not and parenthesis.

\n\n

Example:

\n
\n
"filterable": true, \n "sortable": true\n }\n {\n "id": "count",\n "name": "Count",\n "type": "integer",\n "aggregation": true,\n ===> "filterable": false,\n "sortable": true\n }\n ],\n "data": [\n {\n "description": "total"\n "count": 50\n }\n ]\n }\n}`, `69412805865258550000`)\"\n >\n
Copy
\n
Copied
\n
\n 
{\n    \"page\": 0,\n    \"pageSize\": 100,\n    \"total\": 1,\n    \"sort\": [],\n    \"content\": {\n        \"headers\": [\n            {\n                \"id\": \"description\",\n                \"name\": \"Description\",\n                \"type\": \"string\",\n                \"aggregation\": false,\n        ===>    \"filterable\": true,  \n                \"sortable\": true\n            }\n            {\n                \"id\": \"count\",\n                \"name\": \"Count\",\n                \"type\": \"integer\",\n                \"aggregation\": true,\n        ===>    \"filterable\": false,\n                \"sortable\": true\n            }\n        ],\n        \"data\": [\n            {\n                \"description\": \"total\"\n                \"count\": 50\n            }\n        ]\n    }\n}
\n
\n

You can apply multiple filters separated by commas or use the filterExpr parameter multiple times separated by “&”.

\n

Examples:

\n

filterExpr=opportunity_id eq AA00022475H, opportunity_value gt 50000

\n
\n
\n
Copy
\n
Copied
\n
\n 
filterExpr=opportunity_id eq AA00022475H& \nfilterExpr=opportunity_value gt 50000
\n
\n

New strongly-typed filter expression syntax

\n

Described in detail in OData Filtering Syntax

\n

Differences between legacy and new filter expression syntax

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
New OData SyntaxLegacy Syntax
String values should be single quoted ''String values can be unquoted
Date values should be in ISO-8601 formatDate formatting follows Celonis date format semantics
Only logical operators and,or,notComma (,) can be used instead of and operator
","headings":[{"value":"Filtering","depth":1},{"value":"Predefined Knowledge Model Filters","depth":2},{"value":"Ad-hoc Filter Expressions","depth":2},{"value":"Legacy Filter Expressions","depth":3},{"value":"New strongly-typed filter expression syntax","depth":3},{"value":"Differences between legacy and new filter expression syntax","depth":3}]},"contentItem":{"data":{"lastModified":"2025-10-07T15:06:43.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"facdde5a-4d80-55a9-a219-209ad9058b84__redocly content/process-intelligence-apis/knowledge-model-api/features/filtering/","seo":{"title":"Filtering","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/knowledge-model-api/features/filtering.md","pageBaseUrl":"/process-intelligence-apis/knowledge-model-api/features/filtering","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Filtering","id":"filtering"},{"depth":2,"value":"Predefined Knowledge Model Filters","id":"predefined-knowledge-model-filters"},{"depth":2,"value":"Ad-hoc Filter Expressions","id":"ad-hoc-filter-expressions"},{"depth":3,"value":"Legacy Filter Expressions","id":"legacy-filter-expressions"},{"depth":3,"value":"New strongly-typed filter expression syntax","id":"new-strongly-typed-filter-expression-syntax"},{"depth":3,"value":"Differences between legacy and new filter expression syntax","id":"differences-between-legacy-and-new-filter-expression-syntax"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/knowledge-model-api/features/filtering/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}