API Reference

Search cross different resources

get
https://example.com/datainsights/v1.1/search

Get paginated search result for each requested resource

Notes:

  • Filter values should be formatted column:value, e.g. title:res
  • Valid columns for report resource: title
  • Valid columns for stock_report resource: title
  • API Returns 400 if a column isn't searchable for any requested resource.
  • Rows are returned if column contains values (case-insensitive comparison)
  • The API returns 200 even if no results are found.
Query Params
integer
≥ 0
Defaults to 0

The difference between start of the data and the start of the response data

integer
0 to 100
Defaults to 25

The maximum number of results in the response

filters
array of strings
required

List of comma separated filters to partial match, column:value. Right now is only possible to filter by {'description', 'title'}

filters*
resources
array of strings or null
required

Which resources to search

resources*
Headers
integer
required
≥ 1

Property id of the client

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago