App Data Transfer
Download App Store information and app-install activity about your app.
Overview
Use the App Data Transfer web API to request and download App Store information and app-install activity data about your app. The data available relates to a user’s use of Apple’s App Store and includes information such as previous transactions and downloads. If you have multiple apps, integrate each app with the API separately to enable users to transfer their data to you.
To access the data, you need to acquire an access token with the data-transfer-user-profile read-only scope, and at least one of these scopes:
appstore-info-readonlyapp-install-activity-readonly
For more information, see Request an authorization.
To get permission for your App ID or Services ID to request these scopes, follow the instructions at Account & Organizational Data Sharing.
Set required HTTP headers
When you make requests for your app’s App Store information or app-install activity, using any of the endpoints listed below, set the following HTTP headers:
AuthorizationSet the value to
Bearer <ACCESS_TOKEN>to assert that your app is authorized to fetch data with theappstore-info-account-data-for-EU-usersandappstore-info-account-data-for-UK-usersorapp-install-activity-account-data-for-EU-usersorapp-install-activity-account-data-for-UK-usersscopes.X-Apple-Transaction-IdSet the value to a UUID that uniquely identifies the request. If you need to contact Apple to get support, quote the UUID of the request for which you need help.
Submit a request
Make an HTTP POST request to the Submit request endpoint, requesting the app-store data type. To make a one-time request, set the mode key to ONE_TIME. To make recurring requests, use one of the following values:
DAILY_30One recurring request every day for 30 days
WEEKLY_180One recurring request every week for 180 days
The Apple server returns a request ID, which you use when you get the request status, request download URLs, or cancel the request. For recurring requests, the Apple server returns a request ID, along with the parent ID that identifies the series of recurring requests.
The response from the server also contains a statusCheckDelay, which is the number of seconds you need to wait before checking the status of the request. You can cancel a request before this time by making a POST request to the Cancel request endpoint.
If you submit a DAILY_30 recurring request and don’t resubmit the recurring instance each subsequent day, the recurring request expires 40 days after submission of the request.
If you submit a WEEKLY_180 recurring request and don’t resubmit the recurring instance each subsequent week, the recurring request expires 190 days after submission of the request.
Find the request status
The data corresponding to the request you submitted isn’t available immediately. After the status-check delay expires, make a GET request to Get one-time request status or Get recurring request status, including the request identifier in the path.
If the job status is completed or completed_with_error, the data associated with the request is ready to download.
Transfer data
Get the download URLs for a completed request by making a GET request to Get one-time request download URLs or Get recurring request download URLs, including the request identifier in the path.
The response contains a list of URLs to which you make GET requests, to retrieve the person’s data specific to your app.
Download URLs are available for 3 days after the download request completes. The URLs you receive are valid for 15 minutes after you request them.
For information on the content and terms used in the files you download, see Data and Privacy.
Resubmit recurring requests
Enqueue the next instance of a recurring request by making a POST request to the Resubmit request endpoint, passing the parent request identifier and the request identifier of the most recent instance.
The server’s response contains the request identifier of the new request, and a delay to wait before you can check the new request’s status.