Skip to main content
GET
List all sent and scheduled client reports

Authorizations

x-api-key
string
header
required

Query Parameters

pageIndex
integer
default:0

Zero-based page index (default 0). A page beyond the last one returns 200 with an empty data array, not an error.

Required range: x >= 0
pageSize
integer
default:10

Number of results per page, max 100 (default 10).

Required range: 1 <= x <= 100
sortKey
enum<string>
default:createdAt

Response column to sort by (default createdAt).

Available options:
createdAt,
reportName
sortOrder
enum<string>
default:desc

Sort direction (default desc).

Available options:
asc,
desc
reportName
string

Filter by report name (partial match)

channelId
string

Filter to reports configured for this store/channel. Not applicable for multi-channel reports, which are grouped by tag rather than a fixed set of channels.

merchantId
string

Filter to reports configured for this merchant ID

recipientEmail
string

Only show reports that are scheduled to, or have been sent to, this email address.

isSent
boolean

Filter to reports that have (or have not) ever been sent. Can be combined with isScheduled: isSent=true&isScheduled=true - sent and still scheduled; isSent=true&isScheduled=false - sent but no longer scheduled; isSent=false&isScheduled=true - scheduled but never sent; isSent=false&isScheduled=false - always empty.

isScheduled
boolean

Filter to reports that are (or are not) currently scheduled. Can be combined with isSent: isSent=true&isScheduled=true - sent and still scheduled; isSent=true&isScheduled=false - sent but no longer scheduled; isSent=false&isScheduled=true - scheduled but never sent; isSent=false&isScheduled=false - always empty.

fromDate
integer

Start of date range, as Unix epoch seconds (not milliseconds). Filters on when the report record was created , not the date range the report's own data covers (see reportingPeriod in the response). Defaults to 30 days ago.

toDate
integer

End of date range, as Unix epoch seconds (not milliseconds). Filters on when the report record was created , not the date range the report's own data covers (see reportingPeriod in the response). Defaults to now. The range must not exceed 6 months; passing milliseconds instead of seconds is a common cause of an unexpected "Date range must not exceed 6 months" error.

Response

Successful operation

data
object[]
pagination
object