Survey API Querying

• URL query language

  To improve the query options in our API requests, we are supporting different query options in the Query string. The options are based on the OData URI conventions.
  
  
  Please note not all query options are available for all API requests, the different options are listed for each method in the API Reference

• top

  This option can be used to select only the first N items of the set
  

  By default top 25 is used.

  The maximum allowed value is 1000.

  
  
  Paging made easy!

  When your results are limited, you will automatically get the URL for the next and the previous resultset. The applicable links will be available in the payload.links.next.href and PayLoad.Links.Previous.Href properties. They automatically take the Top, Skip and TotalRowCount into account.

• skip

  Seeking N Entries into the Collection and selecting only the remaining items

• select

  This option can be used to return a subset of the properties. The list of properties can be comma seperated. With select you can limit the amount of data being sent.

• filter

  Filtering the items and selecting only the items that satisfy the predicate expression
  We are supporting below operations/functions

  Logical Operators

  • eq

    Equal

  • ne

    Not equal

  • gt

    Greater than

  • ge

    Greater than or equal

  • lt

    Less than

  • le

    Less than or equal

  Grouping Operators

  • ( )

    Precedence grouping

  String Functions

  • bool substringof(string po, string p1)
  • bool endswith(string p0, string p1)
  • bool startswith(string p0, string p1)

  Logical Operators

  • and

    Logical and

  • or

    Logical or

  Important remarks

  Case sensitive

  The filter option is case sensitive. Please use all operators as listed above in lower cases. The capitals of the properties should be exactly the same as they are mentioned in the API Reference.

  DateTime

  When trying to filter on a DateTime field, you should encapsulate the filter string with DateTime'2024-11-21'. All Date/Time properties are represented in UTC ISO 8601 format.

  When filtering all surveys modified since yesterday you could use /3/surveys?filter=LastModifyDate%20ge%20DateTime'2024-11-20'

  Boolean

  When filtering on a Boolean field, you should use the textual representations true and false

  String functions

  When using the string functions you should still use a Logical Operator.

  When you are looking for all surveys with 'Test' in the name you could use /3/surveys?filter=substringof(Title,'test')%20eq%20true

• orderby

  Determining what properties are used to order the collection of items. You can combine multiple properties comma seperated. By default we use ascending sorting. If you want to use a descending order, you should add desc after the property.

• expand

  By default, some properties aren't filled when retrieving a list of items. We support the option to expand them, the expandable properties are mentioned in the API Reference