List reports

Fields that can be searched on using _search query param

string

Search by Unique identifier of the reports

name

string

Search by name of the reports

file_id

string

Search by file id of the reports

account_id

string

Search by account id of the reports

report_template_id

string

Search by report template id of the reports

Fields with which the list response can be sorted using _sort query param

string

account_id

string

report_template_id

string

Default sort order:id DESC

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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

nextToken

string

pageSize

number

fetchFor

enum<string>

default:

ORGANIZATION

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

Represents a list response for reports

data

object[]

nextToken

string

Introduction

APIs

Allowed filter combinations

Authorizations

Query Parameters

Response