API Reference

Get report based on search results

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

Get reports filtered by different search criteria

Notes:

  • Rows are returned if title 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

string
enum
Defaults to id,asc

Sort reports

ids
array of integers
length ≥ 1

Filter by Report IDs

ids
string
length between 1 and 100

Filter by Report title

string | null

Filter by Report description

dataset_ids
array of integers
length ≥ 1

Filter by Dataset IDs

dataset_ids
string
length ≥ 1

A comma-separated list of the Folder IDs that has reports. Maximum: 50 IDs.

tag_ids
array of integers
length ≥ 1

Tag IDs

tag_ids
user_ids
array of integers
length ≥ 1

Filter reports created by a user ID

user_ids
string

A text string to search for in any of the search column fields

search_columns
array of strings
search_columns
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