Skip to main content
The Apple App Store logo

​
Overview

The App Store integration imports customer reviews of your apps from App Store Connect, including each review’s star rating, territory, and any developer response. Each app you select becomes a dataset. A workspace admin creates the App Store source once for the whole workspace, and channels then add its apps. Learn more about Sources →

​
Before you start

​
In Dovetail

  • A workspace admin creates the source. Other users can request it.
  • The credentials you connect with are shared by the whole workspace. See Shared credentials for how to choose an account.
  • One team key can see every app in its Apple organization, so one source can import reviews for all of them.

​
In App Store Connect

  • A Team API key with the App Manager or Admin role. Individual keys aren’t supported, and in our testing only the App Manager and Admin roles work reliably with the App Store Connect API.
  • The key’s three credentials: the Key ID, the Issuer ID, and the .p8 private key file. Apple lets you download the .p8 file only once, when you create the key, so keep a copy somewhere safe.
  • Someone who can create the key. Creating a Team API key needs access to Users and Access → Integrations → App Store Connect API in App Store Connect, usually the Account Holder or an Admin. If that isn’t you, ask your development or IT team to create the key and send you its credentials. See Apple’s guide to generating a Team key.

​
Create the App Store source

1

Open Sources and select App Store

In the sidebar, select Sources, then select App Store.
2

Connect App Store

Select Connect. Enter the Key ID and Issuer ID, and add your .p8 file. Account developer name is optional. Then select Connect.
3

Choose apps and an import period

In Select apps to import reviews from, choose one or more apps, or choose All apps. Then choose an Import period. See Import period.
4

Choose who can use the source

Choose who can use the source, then select Next. See Create a source.
5

Create the source

Choose whether to auto-redact sensitive information in the source’s data, then select Create source. The first import starts right away. See Redact data from sources.

​
Authentication and permissions

App Store connects with an App Store Connect team API key. Dovetail uses the key only to read your list of apps and their customer reviews. It doesn’t reply to reviews or change anything in App Store Connect. The team key is stored once for the whole workspace. To change the account or credentials, see Reconnect a source.

​
Datasets

For App Store, each dataset is one app, and a channel can add some or all of the source’s apps. Learn more about datasets → The app picker lists only apps that have at least one version live on the App Store. To add more apps later, open the source and select Add app. See Add datasets.

​
What gets imported

Each App Store review becomes one data point.

​
Always imported

​
Imported when present

​
Not imported

  • Reviewer email addresses. Reviews carry only the reviewer’s nickname, so App Store data points aren’t linked to contacts.
  • Device model, app version, and reviewer language.
  • Helpfulness counts and App Store Connect analytics, such as downloads.
To rename the Rating, Territory, or Recipient name field or change its type, see Source fields. Need a field that isn’t on this list? Let us know.

​
Sync behavior

The first import starts when the source is created. After that, the source syncs about every hour. See Manage a source.
  • Import period. The import period applies to the date each review was created. Reviews created before the start of the period aren’t imported.
  • Ongoing sync. Each sync imports reviews created since the previous sync.

​
Troubleshooting

Dovetail can’t validate my credentials. Check that the key is a Team key with the App Manager or Admin role, that the Key ID matches the key exactly, and that the Issuer ID is the team-level issuer ID shown on the Users and Access → Integrations → Team Keys page. Use the .p8 file you downloaded for that key, without editing or renaming it. If you no longer have the file, generate a new team key in App Store Connect and use its credentials. An app is missing from the app picker. An app appears in the picker only while at least one of its versions is live on the App Store. If the picker has no apps at all, check that the key has the App Manager or Admin role, and that it was created in the App Store Connect team that owns your apps. Fewer reviews imported than I see in App Store Connect. The source imports only reviews created within the import period chosen when each app was added. See Get older data. If new reviews have stopped arriving, see Missing or outdated data. App Store isn’t available when I set up a channel. See Troubleshoot sources.

​
Revoke access in App Store

Pausing or deleting the source in Dovetail doesn’t revoke the team key in App Store Connect. To cut off Dovetail’s access, go to Users and Access → Integrations → Team Keys in App Store Connect and revoke the key you used for the source. After you revoke it, the source can’t import new reviews. To pause or delete the source in Dovetail, see Manage a source. To take its data out of one channel, see Channel setup.

Sources

What a source is, and how its data reaches channels.

Channel setup

Add the source’s apps to a channel, or remove them.

Manage a source

Check a source’s status, sync it, pause it, or add apps.

Voice of customer

Bring app reviews together with other customer feedback in Channels.