HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

getReports

Returns report details for the reports that match the filters that you specify.

Usage Plan:

Rate (requests per second)Burst
0.022210

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Query Params
array of strings

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

reportTypes
array of strings

A list of processing statuses used to filter reports.

Show Details
CANCELLEDThe report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return.
DONEThe report has completed processing.
FATALThe report was aborted due to a fatal error.
IN_PROGRESSThe report is being processed.
IN_QUEUEThe report has not yet started processing. It may be waiting for another `IN_PROGRESS` report.
processingStatuses
array of strings

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

marketplaceIds
integer
1 to 100
Defaults to 10

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

date-time

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.

date-time

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

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.

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json