Documentation
Setup your app

Setup Your App

Setup Steps

Mobile Analytics connects directly to the App Store using your Apple App Store Connect API key to access historical and real-time payment data for your app. This information is used to automatically track and display transaction details for each user, helping you effortlessly monitor user purchases and subscription updates.

To set this up, an App Store Connect API Key needs to be generated.

To generate a Team API key for the App Store Connect API (5-minute setup time in 10 easy steps):

  1. Log in to App Store Connect and navigate to Users and Access > API Keys. Here is a link to the API Keys page (opens in a new tab).
  2. Copy the Issuer ID into the first page of the onboarding screen.
  3. Click Generate API Key or the Add (+) button.
  4. Name the key, select the Developer and Sales and Reports roles, and click Generate.
  5. Download the .p8 private key (this is only available once, so store it securely). Copy all the contents into the onboarding screen.
  6. Copy the Key ID in the third column of your API Keys and insert it into the onboarding screen.
  7. Click on your app on App Store Connect (opens in a new tab), navigate to the App Information page (under General), and copy the Apple ID.
  8. Validate your app's connection and check that the API key was integrated with Mobile Analytics successfully.
  9. Setting the Production Server URL on your app's App Information page to the provided ingest link.
  10. All done! Go to your dashboard, and user payment event data will start populating as future payment events occur.

Note: Due to Apple's data access limitations, payment data in Mobile Analytics is available only for users who subscribe, renew, or cancel after the setup is complete. When a new user subscribes to a payment plan, this data will appear in your dashboards. Likewise, if an existing subscriber renews or cancels their subscription, details of all their past transactions can then be retrieved and displayed.

To import historical data prior to setup, please refer to our documentation on Importing Historical Data.

Official Apple Documentation

OverviewSubscription states