Search Filter

There are many different JSON structures that are used by the API endpoints and we do not document them all within this document since you can inspect their schema in the Swagger documentation. However, given the central role and number of options in the Search Filter structure, we do provide some additional help here. The Search Filter structure is what is sent in the search request (i.e. the above example).

Common parameters (this is not all of the parameters):

Name	Type	Example / Usage
page	Integer	page: 3
pageSize	Integer	pageSize: 100
queryString	String	queryString: “Steve Salvins guide to Horse riding”
facets	Object	"facets": { "terms": [ [ "entities.invoice.company" ], [ "entities.invoice.contact" ] ] }
sources	Array of strings	"sources": [ "venezuela" ]
terms	Object	"terms": { "entities.ner.person": [ "Paul Maker", "Gillian Baker" ] }
include	Array of strings	"include": [ "data", "metadata", "actions", "entities" ]