download_sales_report
Download App Store Connect sales and trends reports and return them as parsed rows, covering units sold, proceeds, installs, subscriptions, subscribers, and offer code redemptions.
Instructions
Download a Sales and Trends report and return it as parsed rows.
Covers units sold, proceeds, installs, subscriptions, subscribers and offer code redemptions. See list_sales_report_types for the valid combinations.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | Report version, e.g. "1_0"; defaults to the API's default. | |
| max_rows | No | Cap on returned rows (1-20000). | |
| frequency | Yes | "DAILY", "WEEKLY", "MONTHLY" or "YEARLY". | |
| max_bytes | No | Safety cap after decompression. | |
| report_date | Yes | Date for the frequency: "YYYY-MM-DD" for daily/weekly, "YYYY-MM" for monthly, "YYYY" for yearly. | |
| report_type | Yes | e.g. "SALES", "INSTALLS", "SUBSCRIPTION", "SUBSCRIBER". | |
| vendor_number | No | Overrides $APP_STORE_CONNECT_VENDOR_NUMBER. | |
| report_sub_type | Yes | e.g. "SUMMARY" or "DETAILED". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||