Apple App Store
Apple App Store (formerly known as iTunes Connect) is a suite of web-based tools created for developers to submit and manage their apps for sale in the App Store or the Mac App Store.
The connector queries financial, sales, analytics, and reviews data from the Apple App Store Connect API.
Features
Feature Name | Supported | Notes |
---|---|---|
Capture deletes | ||
History mode | ||
Custom data | ||
Data blocking | check | |
Column hashing | check | |
Re-sync | check | |
API configurable | check | API configuration |
Priority-first sync | ||
Fivetran data models | check | |
Private networking | ||
Authorization via API |
Supported deployment models
We support the SaaS Deployment model for the connector.
Setup guide
Follow our step-by-step Apple App Store setup guide to connect Apple App Store with your destination using Fivetran connectors.
Sync overview
Payments and financial reports
Payments and financial reports have data for monthly earnings, amounts owed, and payments made to you. These reports are generated at the start of each month. They are available only for paid and subscription apps.
Sales and trends reports
Sales and trends provides data to see the performance of your apps and in-app purchases.
- The sales report provides your daily units, proceeds, and sales with content type, app, subscription and territory.
- The subscriptions report has sales and activity for your auto-renewable subscriptions.
Reports are generated daily and imported once they are ready in iTunes. iTunes retains reports for only 365 days, so Fivetran fetches data for the last 365 days during the initial sync.
App Store Analytics reporting
App Store Analytics provides data on user engagement, commerce, and usage information. Refer to App Store Connect Analytics for details.
During the initial import, we fetch data starting from January 1, 2024 UTC and each incremental sync fetches four days' worth of data. You may need to wait up to 48 hours for the report data to sync. See Limitations for more details.
To sync App Store Analytics reports, your App Store API key must have admin or finance permissions. We highly recommend granting admin permissions. See Apple App Store permissions policy for more details.
Reviews
Fetch reviews for your apps. Ratings are fetched with reviews. Ratings without reviews are not fetched (this is a limitation of api calls available from iTunes).
Schema information
Sales and Finance report schema
To zoom, open the ERD in a new window.This schema applies to Apple App Store connections set up before October 25, 2024.
Limitations
App Store Analytics doesn't generate any reports until a report request is submitted. Fivetran submits the reporting requests for your reports. Your reports will be available within 48 hours of creating the report requests. For example, if the report requests are created on August 1, 2024, then the reports are ready on August 3, 2024.
Each sync starts by syncing historical
data and then continues to sync ONGOING
data. If you pause the connector, historical
data will be unavailable for the period during which the connector is paused; only ONGOING
data will be available. This is a source-side limitation.
Due to a source-API limitation, creating a new ONE_TIME_SNAPSHOT
, known as a historical
report request, is available approximately 31 days after the last such request has been made. Hence, we can re-sync analytics tables data only after the 31 days have passed.
Apple App Store permissions policy
To download App Store Analytics reports, ensure your Apple App Store API key has one of the following roles because each role has access to specific reports:
- Admin role - This role allows managing report requests on your behalf and grants read permissions for specific reports.
- Finance role - This role does not allow managing report requests on your behalf, but it does grant read permissions for specific reports.
We recommend you use an API key with admin permissions because it allows Fivetran to manage App Store Analytics report requests without requiring additional user action. Compare the following differences between an API key with admin and finance permissions:
Action | Admin permissions | Finance permissions |
---|---|---|
Create analytics reports requests | Automatically by Fivetran | Manually |
Re-create analytics reports requests | Automatically by Fivetran | Manually |
Re-sync | Automatically by Fivetran. See Perform a Re-Sync With an API Key With Admin Permissions for more details | Partially manually. See Perform a Re-sync With a Non-Admin API Key for more details |
Read and download reports | Available | Available |
Fivetran uses the admin API key to:
- Create an authorization token based on your API key.
- Get a list of your apps.
- Create
ONGOING
andONE_TIME_SNAPSHOT
report requests for each of your apps.
IMPORTANT: Fivetran uses your API key with admin permission only to manage App Store Analytics report requests and get access to your reports, to simplify your user experience. If not granted, you need to create report requests manually.
API key without admin permissions
If you opt to use a non-admin API key, you need to manage report requests manually. We can use a report request you created, but we can't guarantee that we'll successfully sync historical data due to the complex logic of the Apple App Store API and re-sync process.
Use the Request reports API to generate reports for your apps. There are two types of report requests:
ONGOING
- Provides current data. It generates daily, weekly, and monthly reports.ONE_TIME_SNAPSHOT
- Provides comprehensive historical data as far back in time as available and up to the moment of requesting the data. This report doesn't generate any new data, and you need to replace it whenever you want to re-sync your connection. See Perform Re-sync Connection With a Non-Admin API Key for more details.
NOTE: Your first report request generates in 1–2 days. Subsequent
ONGOING
reports are available daily.