Reports
List reports
List reports
GET
Query Parameters
Query Parameters
Filterable Fields
Filterable Fields
Searchable Fields
Searchable Fields
Fields that can be searched on using
_search
query paramSearch by Unique identifier of the reports
Search by name of the reports
Search by file id of the reports
Search by account id of the reports
Search by report template id of the reports
Downloading Reports:
Reports can be downloaded using the fileId
parameter of the Report
entity using the Files API.
Sharing Reports:
Sharable links can be generated using the Generate download URL API which are S3 signed URLs valid for 1 hour and do not require authentication.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Example:
"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
Example:
10
Fetch for flag used to get the reports from:
- ALL: Both the organization and accounts
- ORGANIZATION: Only the organization
- ACCOUNTS: Only accounts, works with account_id filter only.
Available options:
ALL
, ORGANIZATION
, ACCOUNTS
Response
200
application/json
Response for List Report requests
Represents a list response for reports