Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Search

Search cross different resources

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.
get/datainsights/v1.1/search

Query parameters

offsetinteger

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

limitinteger
Example:5

The maximum number of results in the response

filtersstring[] required

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

[
  "title:report title"
]
resourcesstring[] required

Which resources to search

[
  "report"
]

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

OK