Apple App Store Setup Guide

Prerequisites

• An active Apple App Store Connect account with API access enabled by your Account Holder.

Note: After creating or modifying an Apple account, it can take up to 48 hours for Apple to fully provision the account. During this time, some reports may not be available.

Setting up Analytics Reports

Analytics report streams in Matia use incremental sync, but the first sync always runs as a full refresh to load historical data. That means Matia needs two types of analytics report requests in App Store Connect per app:

Request type	When Matia uses it
ONE_TIME_SNAPSHOT	First sync only (historical backfill)
ONGOING	Every sync after the first (daily incremental data)

Choose one of the paths below.

Option A — Matia initializes reports (Admin API key)

1. Generate an API key with the Admin role.
2. In Matia, check This API key has the Admin role.
3. Matia will create ONE_TIME_SNAPSHOT and ONGOING requests automatically on sync for every app in your Apple account.

Option B — You initialize reports (Sales and Reports API key)

1. With an Admin API key (used internally on your side), create both of the following for each app you want Matia to sync analytics data for, via the App Store Connect API:
   • ONE_TIME_SNAPSHOT — required for the first historical sync.
   • ONGOING — required for daily incremental syncs after the first run.
2. You do not need to create requests for every app in your account — only for the apps you want analytics data from.
3. Wait 24–48 hours for the first reports to become available for those apps.
4. Generate a Sales and Reports API key for Matia.
5. In Matia, leave This API key has the Admin role unchecked.

Matia syncs analytics data only for apps that have the required requests. Apps without a request are skipped, the sync continues successfully.

Important: The App Store Connect Analytics dashboard is for viewing metrics in the UI. It does not replace creating analytics report requests through the API.

Setup the connector in Matia

Step 1: Generate API Key in Apple App Store Connect

1. Log in to your Apple App Store Connect dashboard.
2. Navigate to Users and Access, then click on the Integrations tab.
3. Click the Add button.
4. Complete the Generate API Key form and click Generate.
5. Assign the appropriate role:
   • Admin — if Matia should initialize analytics report requests (Option A).
   • Sales and Reports — if you initialize report requests yourself (Option B).
6. Save the Issuer ID and Key ID of the generated key and the API Key file. You will need these credentials to configure Matia.

Step 2: Locate Your Vendor Number

1. In the Apple App Store Connect dashboard, navigate to the Reports page.
2. Find the Vendor Number and record it for configuration purposes.
3. If you have multiple accounts, save the Vendor Number for each account you intend to sync.

Step 3: Complete Configuration in Matia

1. Enter an Asset Name.
2. Enter the Key ID and Issuer ID from the API key you created.
3. Upload the API Key file you downloaded from Apple.
4. If using Option A, check This API key has the Admin role. If using Option B, leave it unchecked.
5. Click + Add to enter the Vendor Number you located in the Vendor Id field. Multiple Vendor Numbers can be added if needed.
6. Select your Apps sync mode:
   • Choose Sync all apps to sync data for all apps under your Apple account.
   • Choose Sync specific apps to select which apps to sync.
7. Choose the Replication start date.
8. (Optional) Enter a Description.
9. (Optional) Assign Tags.
10. Select an Owner.
11. Verify that your Apple App Store Connect account is successfully connected by clicking on Test Connection.
12. Click Connect.