Querying reports metadata
In most cases the Get Reports
API is all you need, as it contains the reportDocumentId
required to download the report document. If there is a need to get additional information about a specific report, use the Get Report By Id
API.
Get Report By Id
Returns report details for the given reportId
.
Request
Request parameters
Name | Location | Description |
---|---|---|
reportId (required) Type: string |
Path Parameter | Report identifier |
Response
Returns HTTP 200 status response code if the operation was successful.
{
"reportId": "A08439021T39K6DTX4JS8",
"reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SETTLEMENT_DATA_",
"startTime":"20221118T150630Z",
"endTime":"20221202T150350Z",
"createdTime":"20221207T170826Z",
"processingStatus": "COMPLETED",
"processingStartTime":"20221207T170826Z",
"processingEndTime":"20221207T170826Z",
"reportDocumentId": "amzn1.tortuga.3.45ee712dc-3512-6cbd-ad71-ab3cb4cffef7.T3FKJJI01Y1E32"
}