Apple App Store

Creating the data source

Requirements

To add the data source, you’ll need to access the App Store Connect website using the main account user and follow these steps

Instructions

Using your main account user, go to https://appstoreconnect.apple.com/
Once logged in, navigate to the “Users and Access” section
On the Users and Access page, click on “Keys” at the top, then click the “Generate API Key” button
When creating the key, a pop-up will appear. Enter a name under “Name” (e.g., “Kondado”), select the access level “Admin” under “Access,” and click “Generate” to create the key
Once the key is created, it will appear in the key list. You’ll need to copy the following information as shown below:
1. Copy the “Issuer ID” (located at the top)
2. Copy the “KEY ID” (located in the third column of the key)
3. Download the key by clicking “Download API Key” in the last column
The downloaded key will have a “.p8” extension. When you open it with a text editor, you’ll see a block of text like the example below (this one is randomly generated and not valid). Copy the entire text without leading or trailing spaces
On the App Store Connect website, locate the “Reports” option in the top menu and click on it
On the Reports page, in the upper left, you’ll see your company name and below it something like “Vendor # 12345678”. Copy the number after the “#” with no spaces. In this example, you would copy “12345678”
Log in to the Kondado platform, click on CREATE+ > Data Source > select the Apple App Store data source, and fill in the information as shown below
1. 1. Vendor ID: Paste the number obtained in step (8)
  2. Issuer ID: Paste the text obtained in step (5.1)
  3. Key ID: Paste the text obtained in step (5.b)
  4. Key: Paste the full text (remember to remove any leading or trailing spaces) as obtained in step (6)

Pipelines

Relationship chart

Click to expand

Daily Downloads and Sales Summary Report

Data older than 365 days is not available. There may be a delay of a few days in making recent data available
Includes download and sales data for all app types, such as:
- Units: shows how many times your app was downloaded (first-time downloads only, does not include re-downloads)
- Developer Proceeds: earnings from paid apps or in-app purchases (if applicable)
- Refunds, Updates, and Promo Codes (if used)

Campo	Tipo
metric_date	date	[en] Report date
category	text	[en] Indicates the category of the app, such as Games.
customer_currency	text	[en] Three-character ISO code indicating the customer’s currency
title	text
currency_of_proceeds	text	[en] The currency in which your proceeds are earned
version	text	[en] Provided by you during app setup.
provider	text	[en] The service provider in your reports (typically Apple).
units	float	[en] The aggregated number of units. Negative values indicate refunds, or CMB credits for previously purchased apps when the CMB column shows ‘CMB-C’. A 0 value may indicate a partial refund
parent_identifier	text	[en] In-App Purchases will show the SKU of the associated app.
developer_proceeds	float	[en] The amount you receive per unit. This is the Customer Price minus applicable taxes and Apple’s commission, per Schedule 2 of your Paid Applications agreement .
customer_price	float	[en] The price per unit billed to the customer, which you set for your app or in-app purchase in App Store Connect . *Customer price is inclusive of any applicable taxes we collect and remit per Schedule 2 of the Paid Applications agreement. Negative values indicate refunds, or CMB credits for previously purchased apps when the CMB column shows ‘CMB-C’.
sku	text	[en] A product identifier provided by you during app setup.
product_type_identifier	text	[en] Defines the type of transaction (for example, initial download, update, and so on). For more information, visit Product type identifiers at https://developer.apple.com/help/app-store-connect/reference/product-type-identifiers
provider_country	text	[en] The service provider country code (typically U.S.).
proceeds_reason	text	[en] The service provider country code (typically U.S.).
device	text	[en] Type of device used for purchase or redownload: iPhone, iPad, Apple TV, iPod touch, or Desktop.
subscription	text	[en] Defines whether an auto-renewable subscription is new or a renewal.
apple_identifier	text	[en] The Apple ID for your app.
supported_platforms	text	[en] List of platforms that your app supports: iOS, tvOS, iOS and tvOS, or macOS.
country_code	text	[en] Two-character ISO country code indicating the App Store territory for the purchase
cmb	text	[en] If the transaction involves a “completed” app bundle, this field will contain a value of “CMB.” App credits for completed bundles will show a value of “CMB-C.” Otherwise this field is blank.
client	text	[en] Indicates where the purchase happened: App Store for iMessage, News, or blank.
promo_code	text	[en] If the transaction was part of a promotion, this field will contain a value. This field is empty for all non-promotional items. For more information, visit Promotional codes .
period	text	[en] Defines the duration of an auto-renewable subscription purchase. Values include: 7 days, 1 month, 2 months, 3 months, 6 months, and 1 year.
order_type	text	[en] For introductory offers or subscription offers, indicates what type of transaction this line item is: Pay Up Front or Pay As You Go. For pre-orders, indicates whether a purchase originated from a Pre-Order. For promotional offers, the field will populate the Order ID. For offer codes, the field will populate the offer code reference name used in App Store Connect when setting up the subscription offer.
developer	text	[en] Provided by you during the initial account setup.
preserved_pricing	text	[en] For Renew events, if the price is preserved then this field equals “Yes”. Otherwise it is blank.

Daily Subscriber Detailed Report

Data older than 365 days is not available. There may be a delay of a few days in making recent data available
This pipeline will not include data (and might even fail) for your app if:
- Your app is free to download, and
- You do not use Apple's in-app purchase (IAP) system for subscriptions or payments.

Campo	Tipo
metric_date	date	[en] Report date
customer_currency	text	[en] Three-character ISO code indicating the customer’s currency
subscriber_id	text	[en] The randomly generated Subscriber ID that is unique to each customer and developer.
purchase_date	text	[en] For refunds, the date of the original purchase.
subscriber_id_reset	text	[en] If a customer cancels all of their subscriptions with you and does not resubscribe within 180 days, the Subscriber ID will be deleted. If the same customer resubscribes after 180 days, then we create a new Subscriber ID and this field equals “Yes.” Otherwise, it is blank.Subscriber IDs are reset when an app is transferred to another developer account .
subscription_group_id	text	[en] Your subscription’s Group ID (formerly Family ID).
standard_subscription_duration	text	[en] Duration of the standard subscription: 7 Days, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.
subscription_offer_name	text	[en] The promotional offer reference name or the offer code reference name used in App Store Connect when setting up the subscription offer.
app_apple_id	text	[en] Apple ID of your subscription’s parent app.
developer_proceeds	float	[en] The proceeds for each item delivered.
customer_price	float	[en] The price of your auto-renewable subscription. Negative values indicate refunds.
subscription_offer_duration	text	[en] Duration of the introductory price if applicable: For example, 3 Days, 1 Week, 2 Weeks, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.
promotional_offer_id	text	[en] A code that you create for customers to enter and redeem the subscription offer.
event_date	date	[en] Date the event occurred
proceeds_reason	text	[en] If a subscription has been active for more than a year then you receive 85 percentage of the customer price, minus applicable taxes, and this field equals “Rate After One Year.” Otherwise, you receive 70 percentage and the field is blank.
device	text	[en] Type of device used for subscription purchase: iPhone, iPad, Apple TV, iPod touch, or Desktop.
units	float	[en] The aggregated number of units.
subscription_apple_id	text	[en] Apple ID of your subscription.
country	text	[en] Two-character ISO country code indicating the App Store territory for the purchase
marketing_opt_in_duration	text	[en] Duration of the marketing opt-in if applicable: 7 Days, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.
proceeds_currency	text	[en] The currency in which your proceeds are earned.
client	text	[en] If the subscription was purchased from News then this field equals “News”. Otherwise, it is blank.
refund	text	[en] For full or partial refunds, this field equals “Yes.” Otherwise, it is blank.
subscription_name	text	[en] Title of your subscription.
app_name	text	[en] Title of your subscription’s parent app.
subscription_offer_type	text
preserved_pricing	text	[en] For renewals, if the price is preserved then this field equals “Yes”. Otherwise, it is blank.

Daily Subscription Event Summary Report

Data older than 365 days is not available. There may be a delay of a few days in making recent data available
This pipeline will not include data (and might even fail) for your app if:
- Your app is free to download, and
- You do not use Apple's in-app purchase (IAP) system for subscriptions or payments.

Campo	Tipo
metric_date	date	[en] Report date
days_canceled	float	[en] For reactivate events, the number of days ago that the subscriber canceled.
subscription_group_id	text	[en] Your subscription’s Group ID (formerly Family ID).
previous_subscription_name	text	[en] For upgrade, downgrade, and crossgrade events, the title of the previous subscription.
standard_subscription_duration	text	[en] Duration of the standard subscription: 7 Days, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.
promotional_offer_name	text	[en] The Promotional Offer Reference Name used in App Store Connect when setting up the offer.
state	text	[en] State field in the address submitted by the customer when signing up for their Apple ID. This field is not validated and may be blank.
app_apple_id	text	[en] Apple ID of your subscription’s parent app.
days_before_canceling	float	[en] For cancel events, the number of days from the start date to when a subscriber canceled, which could be in the middle of the period. This only applies to cancel events where cancellation reason equals ‘canceled‘. Otherwise, it is blank.
subscription_offer_duration	text	[en] Duration of the introductory price if applicable. For example: 3 Days, 7 Days, 2 Weeks, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.
promotional_offer_id	text	[en] An identifier that you set for your subscription offers in App Store Connect. This is the value entered in the Promotional Offer Product Code field when setting up a subscription offer. For details on implementation see Generating a Signature for Promotional Offers .
marketing_opt_in	text	[en] If the subscription included a marketing opt-in then this field equals “Yes”. Otherwise, it is blank.
proceeds_reason	text	[en] For Renew events, if the subscription has been active for more than a year then you receive 85 percent of the customer price, minus applicable taxes, and this field equals “Rate After One Year”. Otherwise, you receive 70 percent and the field is blank.
device	text	[en] Type of device used for initial subscription purchase: iPhone, iPad, Apple TV, iPod touch, or Desktop.
original_start_date	date	[en] Date of the initial subscription purchase.
cancellation_reason	text	[en] Reason for a cancellation: Billing issue, Price increase, Canceled, Removed from Sale, or Other
subscription_apple_id	text	[en] Apple ID of your subscription.
country	text	[en] Two-character ISO country code indicating the App Store territory for the purchase
marketing_opt_in_duration	text	[en] Duration of the opt-in if applicable: 7 Days, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.
client	text	[en] If the subscription was purchased from News then this field equals “News”. Otherwise, it is blank.
previous_subscription_apple_id	text	[en] For upgrade, downgrade, and crossgrade events, the Apple ID of the previous subscription.
quantity	float	[en] Number of events with the same values for the other fields.
subscription_name	text	[en] Title of your subscription.
app_name	text	[en] Title of your subscription’s parent app.
consecutive_paid_periods	float	[en] The total number of paid periods that the subscription has been active without cancellation. This does not include free trials, marketing opt-in bonus periods, or grace periods.
subscription_offer_type	text	[en] Type of introductory price: Pay Up Front, Pay As You Go, or Free Trial
event	text	[en] Type of event that occurred
preserved_pricing	text	[en] For Renew events, if the price is preserved then this field equals “Yes”. Otherwise, it is blank.

Daily Subscription Summary Report

Data older than 365 days is not available. There may be a delay of a few days in making recent data available
This pipeline will not include data (and might even fail) for your app if:
- Your app is free to download, and
- You do not use Apple's in-app purchase (IAP) system for subscriptions or payments.

Campo	Tipo
metric_date	date	[en] Report date
subscription_offer_name	text	[en] The promotional offer reference name or the offer code reference name used in App Store Connect when setting up the subscription offer
customer_currency	text	[en] Three-character ISO code indicating the customer’s currency
free_trial_offer_code_subscriptions	float	[en] Total number of offer code subscriptions currently in a free trial.
pay_up_front_offer_code_subscriptions	float	[en] Total number of offer code subscriptions with a pay up front offer price.
pay_as_you_go_offer_code_subscriptions	float	[en] Total number of offer code subscriptions with a pay as you go offer price.
subscribers	float	[en] The number of subscribers who have access to the auto-renewable subscription including entitled family members. Note that this field is only populated when the record represents more than 3 subscriptions
billing_retry	float	[en] Total number of subscriptions in the Billing Retry status. This indicates that the App Store is still attempting to automatically renew a subscription when billing issues arise (for example, an expired credit card). Available in reports for dates starting December 7, 2017.
free_trial_promotional_offer_subscriptions	float	[en] Total number of promotional offers currently in a free trial.
standard_subscription_duration	text	[en] Duration of the standard subscription: 7 Days, 1 Month, 2 Months, 3 Months, 6 Months, or 1 Year.
state	text	[en] State field in the address submitted by the customer when signing up for their Apple ID. This field is not validated and may be blank.
app_apple_id	text	[en] Apple ID of your subscription’s parent app.
active_standard_price_subscriptions	float	[en] Total number of auto-renewable standard paid subscriptions currently active, excluding free trials, subscription offers, introductory offers, and marketing opt-ins. Subscriptions are active during the period for which the customer has paid without cancellation.
developer_proceeds	float	[en] The proceeds for each subscription.
active_pay_as_you_go_introductory_offer_subscriptions	float	[en] Total number of introductory offer subscriptions currently with a pay as you go introductory price.
customer_price	float	[en] Retail Price displayed on the App Store and charged to the customer.
promotional_offer_id	text	[en] An identifier that you set for your subscription offers in App Store Connect. For Promotional Offers this is the value entered in the Promotional Offer Reference Name field when setting up the offer. For one-time use offer codes, this is the value entered in the Offer Code Reference Name field when setting up the offer. For custom offer codes this is the code shared with your users.
proceeds_reason	text	[en] For Renew events, if the subscription has been active for more than a year then you receive 85 percent of the customer price, minus applicable taxes, and this field equals “Rate After One Year”. Otherwise, you receive 70 percent and the field is blank.
device	text	[en] Type of device used for subscription purchase: iPhone, iPad, Apple TV, iPod touch, or Desktop.
pay_up_front_promotional_offer_subscriptions	float	[en] Total number of promotional offers with a pay up front promotional price.
pay_as_you_go_promotional_offer_subscriptions	float	[en] Total number of promotional offers with a pay as you go promotional price
active_free_trial_introductory_offer_subscriptions	float	[en] Total number of introductory offer subscriptions currently in a free trial
marketing_opt_ins	float	[en] Total number of subscriptions currently in a marketing opt-in bonus period
subscription_apple_id	text	[en] Apple ID of your subscription
country	text	[en] Two-character ISO country code indicating the App Store territory for the purchase
proceeds_currency	text	[en] The currency in which your proceeds are earned
subscription_group_id	text	[en] Your subscription’s Group ID (formerly Family ID).
client	text	[en] If the subscription was purchased from News then this field equals “News”. Otherwise, it is blank.
subscription_name	text	[en] Title of your subscription.
app_name	text	[en] Title of your subscription’s parent app.
active_pay_up_front_introductory_offer_subscriptions	float	[en] Total number of introductory offer subscriptions currently with a pay up front introductory price.
preserved_pricing	text	[en] For Renew events, if the price is preserved then this field equals “Yes”. Otherwise, it is blank.
grace_period	text	[en] Total number of subscriptions in the Billing Grace Period state. This indicates that subscriber can continue accessing your content for a certain period of time (6 or 16 days) while Apple attempts to correct the billing issue