Responses
Query responses
Fetch review responses via API.
GET
Query responses
See Introduction for the base URL and authentication.
Equal (
Not Equal (
Greater Than (
Greater Than or Equal (
Less Than (
Less Than or Equal (
Note: The
Query Parameters
Filter by response values. See Filtering Response Values for more details.
Filtering Response Values
ThefilterResponseValues parameter allows you to filter responses based on their field values. This parameter accepts an array of filter objects that are combined with AND logic.
Filter Array (as JSON string):
Supported Operations
Scalar Operations:==- Field equals value (example)!=- Field does not equal value (example)>- Field > value (example)>=- Field >= value (example)<- Field < value (example)<=- Field <= value (example)contains- Field contains substring (example)startsWith- Field starts with substring (example)endsWith- Field ends with substring (example)isTrue- Field is true (example)isFalse- Field is false (example)
arrayIncludes- Array contains value (example)arrayExcludes- Array does not contain value (example)arrayIsEmpty- Array is empty (example)arrayIsNotEmpty- Array is not empty (example)
reviewResult.data field that you receive in review completion events to your webhooks:
Examples
Equal (==)
Not Equal (!=)
Greater Than (>)
Greater Than or Equal (>=)
Less Than (<)
Less Than or Equal (<=)
Contains
Starts With
Ends With
Is True
Is False
Array Includes
Array Excludes
Array Is Empty
Array Is Not Empty
Array Property Includes
array[].property syntax is used for filtering by/comparing with a nested property value when the array items are objects. This works like a .map() operation, allowing you to access properties within array elements.