Report document
get_report_documentDownload and parse an SP-API report document into rows/columns. GZIP-compressed and uncompressed documents are supported; ZIP and restricted report types are not supported. Given a reportDocumentId (from create_report or get_report), returns the report payload as structured rows. Returns the report's facts as-is and never recommends actions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Payload parse format. 'auto' (default) tries JSON first and falls back to TSV; 'json' parses a JSON array/object of rows; 'tsv' parses a tab-separated table with a header row. | auto |
| max_rows | No | Maximum number of rows to parse and return (1-5000, default 500). Reports larger than this are truncated; pass a higher value for the full table up to the cap. | |
| array_key | No | For JSON reports whose rows are wrapped under a key (e.g. dataByAsin, salesAndTrafficByAsin), the key to unwrap. Ignored for TSV. | |
| report_type | No | Optional SP-API report type (e.g. GET_SALES_AND_TRAFFIC_REPORT). Used for diagnostics and to hint at the payload format. Restricted report types that require a restricted data token are not supported. | |
| report_document_id | Yes | The reportDocumentId returned by create_report or get_report (SP-API Reports API). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| evidence | No |