Interface ReportsApiGetReportsRequest

Request parameters for getReports operation in ReportsApi.

Export

ReportsApiGetReportsRequest

interface ReportsApiGetReportsRequest {
    createdSince?: string;
    createdUntil?: string;
    marketplaceIds?: string[];
    nextToken?: string;
    pageSize?: number;
    processingStatuses?: ("CANCELLED" | "DONE" | "FATAL" | "IN_PROGRESS" | "IN_QUEUE")[];
    reportTypes?: string[];
}

Properties

createdSince? createdUntil? marketplaceIds? nextToken? pageSize? processingStatuses? reportTypes?

Properties

Optional Readonly createdSince

createdSince?: string

The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.

Memberof

ReportsApiGetReports

Optional Readonly createdUntil

createdUntil?: string

The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.

Memberof

ReportsApiGetReports

Optional Readonly marketplaceIds

marketplaceIds?: string[]

A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.

Memberof

ReportsApiGetReports

Optional Readonly nextToken

nextToken?: string

A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.

Memberof

ReportsApiGetReports

Optional Readonly pageSize

pageSize?: number

The maximum number of reports to return in a single call.

Memberof

ReportsApiGetReports

Optional Readonly processingStatuses

processingStatuses?: ("CANCELLED" | "DONE" | "FATAL" | "IN_PROGRESS" | "IN_QUEUE")[]

A list of processing statuses used to filter reports.

Memberof

ReportsApiGetReports

Optional Readonly reportTypes

reportTypes?: string[]

A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.

Memberof

ReportsApiGetReports

Settings

Member Visibility

Theme

On This Page

createdSincecreatedUntilmarketplaceIdsnextTokenpageSizeprocessingStatusesreportTypes