Documentation

Description

‍Apple App Store platform allows developers to access detailed data about apps, including metadata, reviews, rankings, and sales reports. It enables integration with App Store services, facilitating app management and analytics directly from third-party tools or custom interfaces.

The schema information shows all report types you can use to extract data from Apple App Store.

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

Step 1. Click the Make a new Connection on the Connections page.
Categories on the Data sources page group all available platforms. Use a search to find the required one.

Step 2. Click on the Apple App Store tile.

Step 3. Authorize your Apple App Store account using the following fields:

• Account Name (Organization Name)
• Key Type
• Key ID
• Private Key
• Issuer ID - only for Team Key

More details on how to get these fields are in Step 4.

Step 4. This connection requires a Key with an Admin Role to request App Analytics reports.

‍Key Type

There are two types of API keys:

Generating Key

Generate a Team Key and Assign It a Role

To generate team keys, you must have an Admin account in App Store Connect. You can generate multiple API keys with any roles you choose.

To generate a team API key to use with the App Store Connect API, log in to App Store Connect and:

1. Select Users and Access, and then select the API Keys tab.
2. Make sure the Team Keys tab is selected.
3. Click Generate API Key or the Add (+) button.
4. Enter a name for the key. The name is for your reference only and isn’t part of the key itself.
5. Under Access, select the role for the key.
6. Click Generate.

The new key’s name, key ID, a download link, and other information appears on the page.

Download and Store a Team Private Key

Once you’ve generated your API key, you can download the private half of the key. The private key is available for download a single time, to begin log in to App Store Connect and:

1. Select Users and Access, and then select the API Keys tab.
2. Click Download API Key link next to the new API key.

The download link only appears if you haven’t downloaded the private key. Apple doesn’t keep a copy of the private key.

‍Get your Issuer ID (relevant only for Team Key)

To get your issuer ID, log in to App Store Connect and:

1. Select Users and Access.
2. Select the API Keys tab.

The issuer ID appears near the top of the page. To copy the issuer ID, click Copy next to the ID.

Generate an Individual Key

To generate an individual API key, which has access and permissions of the associated user, for the App Store Connect API, log in to App Store Connect and:

1. Go to a your user profile.
2. Scroll down to Individual API Key.
3. Click Generate API Key.

The key ID, a download link, and other information appears on the page.

Download and Store an Individual Private Key

Once you’ve generated your API key, you can download the private half of the key. The private key is available for download a single time, to begin log in to App Store Connect and:

1. Go to your user profile.
2. Scroll down to Individual API Key.
3. Click Download API Key link.

The download link only appears if you haven’t downloaded the private key. Apple doesn’t keep a copy of the private key.

Filling in Private Key

The Private part of your key will look like this:

----BEGIN PRIVATE KEY-----
2IddB3O6wnjyOWwUemfdsTRLuCEY79gbe5RVsG2mVRQQ8t7qXHvP7yhMG2MPenxa 
ijKxT59EQLeqO1yzt8EJO6iiU5gxyJFQCTBQ4EymGQSDFplBlLVfC3v7wVy391mD 
KyIZgzRq6uNtn3sKtYkwBrWzJK1NbQ2fjytgYFwTLb2nTo7C4hkE5O5q
-----END PRIVATE KEY-----

Due to UI input field form specifics, the line breaks need to be converted to ```"\n"```, so it will look like this:

----BEGIN PRIVATE KEY-----
\n2IddB3O6wnjyOWwUemfdsTRLuCEY79gbe5RVsG2mVRQQ8t7qXHvP7yhMG2MPenxa\nijKxT59EQLeqO1yzt8
EJO6iiU5gxyJFQCTBQ4EymGQSDFplBlLVfC3v7wVy391mD\nKyIZgzRq6uNtn3sKtYkwBrWzJK1NbQ2fjytgYF
wTLb2nTo7C4hkE5O5q\n-----END PRIVATE KEY----- 

And this is how it should be pasted to input field form.

Step 5. After completing the connection process, the Apple App Store connection will appear in your Connected sources list.

Step 6. When the connection status is Active, and the account status column shows a number of accounts, you can move on to data extraction.

Step 7. To extract data from the connected sources, check the instructions on how to set up data extraction.