Download Sales and Trends Reports
Download sales and trends reports filtered by your specified criteria.
URL
GET https://api.appstoreconnect.apple.com/v1/salesReportsQuery Parameters
| Name | Type | Description |
|---|---|---|
filter[frequency] Required | [string] | Frequency of the report to download. For a list of values, see Allowed values based on sales report type table below. |
filter[reportDate] Optional | [string] | The report date to download. Specify the date in the |
filter[reportSubType] Required | [string] | The report sub type to download. For a list of values, see Allowed values based on sales report type table below. |
filter[reportType] Required | [string] | The report to download. For more details on each report type see Download and view reports. |
filter[vendorNumber] Required | [string] | You can find your vendor number in View payments and proceeds. |
filter[version] Optional | [string] | The version of the report. For a list of values, see Allowed values based on sales report type table below. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/a-gzip | gzip | The request completed successfully. |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 429 | Content-Type: application/json | ErrorResponse |
Mentioned in
Discussion
Allowed values based on sales report type
Each sales report type has specific valid values for reportType, reportSubType, frequency, and version. If you use other types, it results in an error. For more details on each report type, see Download and view reports.
|
|
|
|
|---|---|---|---|
FIRST_ANNUAL | DETAILED | DAILY | 1_0 |
FIRST_ANNUAL | SUMMARY | YEARLY | 1_0 |
INSTALLS | SUMMARY_CHANNEL | YEARLY | 1_0, 1_1 |
INSTALLS | SUMMARY_INSTALL_TYPE | YEARLY | 1_0, 1_1 |
INSTALLS | SUMMARY | MONTHLY | 1_2 |
INSTALLS | SUMMARY_TERRITORY | YEARLY | 1_0, 1_1 |
INSTALLS | DETAILED | MONTHLY | 1_2 |
INSTALLS | DETAILED | YEARLY | 1_0, 1_1 |
NEWSSTAND | DETAILED | DAILY, WEEKLY | 1_0 |
PRE_ORDER | SUMMARY | DAILY, WEEKLY, MONTHLY, YEARLY | 1_0 |
SALES | SUMMARY | DAILY, WEEKLY, MONTHLY, YEARLY | 1_0 |
SUBSCRIBER | DETAILED | DAILY | 1_3 |
SUBSCRIPTION | SUMMARY | DAILY | 1_3 |
SUBSCRIPTION_EVENT | SUMMARY | DAILY | 1_3 |
SUBSCRIPTION_OFFER_CODE_REDEMPTION | SUMMARY | DAILY | 1_0 |
WIN_BACK_ELIGIBILITY | SUMMARY | DAILY | 1_0 |