Search reports
Searches for and returns pages of reports using a variety of filters. Search is eventually-consistent; changes to dashboards may take a few seconds to reflect in search results.
Also supports retrieving pages of archived reports; however, the following restrictions apply: only the limit and after parameters are respected, all others are ignored; archived report retrieval does not support filtering, custom sorting, or property projection. Results are always returned in order from most recently deleted to least recently deleted.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
A cursor token for pagination. Use the value from the previous response's paging.next.after field.
Whether to retrieve archived reports only. Default false.
Filter to reports that are a part of the specified business units.
Filter to reports created after a specific date and time.
Filter to reports created before a specific date and time.
Filter to reports on the specified dashboard.
Filter to reports with the specified IDs.
The maximum number of results to display per page. Default 25, max 100.
Filter to reports that are on, or not on, any dashboard. Unset by default.
Filter to only reports that are favorited by the requesting user. Default false.
Filter to reports owned by the specified users.
Additionally properties to include in the response. Refer to the response details for available fields.
Filter to reports whose name or description contains the search string.
Sort field and direction. Supported fields are name, updatedAt, and lastViewedAt. Defaults to -updatedAt
Filter to reports tagged with the specified tags.
Filter to reports updated after a specific date and time.
Filter to reports updated before a specific date and time.
Response
successful operation