Apple App Store Setup Guide

Follow our setup guide to connect Apple App Store to Fivetran.

Prerequisites

To connect Apple App Store to Fivetran, you need an Apple account. Make sure your Apple account has at least the Finance role.

NOTE: When you add or create an Apple account, it may take up to 48 hours for Apple to process the new account. During this time, some reports cannot be retrieved.

Setup instructions

Create API key in Apple App Store

1. Log in to the Apple App Store dashboard.

2. Click Users and Access, then go to the Integrations tab.

3. Click the Add(+) button.

4. Fill in the Generate API Key form and click Generate.

   NOTE: We recommend selecting the Finance and App Manager roles for the Fivetran API key. Assign the Admin role to the Fivetran API key if you plan to sync analytics report tables.

5. Make a note of the Issuer ID and Key ID of the generated key, and download the API Key file. You will need them to configure Fivetran.

Find your vendor number

1. In the Apple App Store dashboard, go to the Reports page.

2. Find the Vendor number and make a note of it. You will need it to configure Fivetran.

   NOTE: If you have several accounts, make a note of the vendor number for each account that you want to sync.

Finish Fivetran configuration

1. In the connector setup form, enter the Destination schema name of your choice.

2. Enter the Issuer ID and Key ID of the API key you created.

3. Upload the API Key file you downloaded.

4. Enter the Vendor ID you found.

   NOTE: We use the Vendor ID to filter Sales / Finance reports data.

5. Select your app sync mode:

   • Choose Sync All Apps to sync all your apps.
   • Choose Sync Specific Apps to sync specific apps only. Select the apps you'd like to sync.

   NOTE: We filter Analytics reports data based on the Apps selected.

6. In the Historical Sync Time Frame drop-down, select how many months' worth of reporting data you'd like to include in your initial sync.

7. Click Save & Test. Fivetran will take it from here and sync your Apple App Store data.

App Store Analytics reporting

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.

IMPORTANT: 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.

IMPORTANT: 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. We can re-sync analytics tables data only after the 31 days have passed.

Related articles

description Connector Overview

account_tree Schema Information

assignment Release Notes

settings API Connector Configuration

home Documentation Home