Filtering and Sorting

Syntax

• Filters is a comma-delimited list of Name + Operator + Value where Name is the name of the property you are choosing to filter. Operator is one of the Operators in the below table. Value is the value to use for filtering. Both Name and Value can have multiple values making use of OR logic. For Name this can be done by enclosing them in brackets and using a pipe delimiter, eg. (LikeCount|CommentCount)>10 asks if LikeCount or CommentCount is >10. For Value you would only need to use a pipe delimiter, eg. Title@=new|hot will return posts with titles that contain the text "new" or "hot".
• Sorts is a comma-delimited list of property names to sort by. In case of multiple properties the priority of the sorting depends on the order of the properties in the query. Adding a - before the name switches to sorting in a descending order. eg. -createdBy.
• Page is the number of the page to return.
• PageSize is the number of items returned per page.

Notes:

• You can have spaces anywhere except within Name or Operator fields.
• You can use backslashes to escape special characters and sequences:
  • commas: Title@=some\,title makes a match with "some,title"
  • pipes: Title@=some\|title makes a match with "some|title"
  • null values: Title@=\null will search for items with title equal to "null" (not a missing value, but "null"-string literally)

👍

Apply filtering at the server side

It is recommended to request only the specific data that is required by using filters available with the endpoints.

Examples for filtering and sorting

Operators