Apple App Store Connect: Most-used fields#
The table below gives information about most-used fields that you can import from Apple App Store Connect. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
App ID |
App ID |
A unique identifier automatically generated by Apple for the app within App Store Connect, used for identifying the app across various reports and on the App Store. |
dimension |
App Name |
App Name |
The localized name of the app as displayed on App Store product pages and when users install the app. |
dimension |
Apple Identifier |
Apple Identifier |
A unique numerical identifier assigned to an application within Apple’s App Store Connect, used to identify the app for management and reporting purposes. |
metric |
Begin Date |
Begin Date |
The start date of the reporting period for sales and trend reports. |
dimension |
Category |
Category |
The primary classification of the application on the App Store, which helps users discover apps based on their function or content. This includes categories, subcategories, and secondary categories. |
dimension |
Channel |
Channel |
The marketing or distribution channel through which an app install was acquired, available in sales and trends reports. |
dimension |
Country Code |
Country Code |
The country code associated with the transaction or install in sales reports. |
dimension |
Currency of Proceeds |
Currency of Proceeds |
The currency in which the developer’s earnings (proceeds) are reported. |
dimension |
Customer Currency |
Customer Currency |
The currency used by the customer for the purchase. |
dimension |
Customer Price |
Customer Price |
The price paid by the customer for the app or in-app purchase. |
metric |
Developer |
Developer |
The developer or organization responsible for the application. |
dimension |
Developer Proceeds |
Developer Proceeds |
The net earnings received by the developer from sales after Apple’s commission. |
metric |
Device |
Device |
The type of Apple device on which the application is installed or for which data is being reported (e.g., iOS, macOS, Universal). |
dimension |
End Date |
End Date |
The end date of the reporting period for sales and trend reports. |
dimension |
First Annual Installs |
First Annual Installs |
The count of an app’s initial installations within a given annual period, available through the FIRST_ANNUAL report type. |
metric |
Install Type |
Install Type |
The classification of an app install, such as a first-time download or a re-download, available as a report sub-type for install reports. |
dimension |
Installs Above Threshold |
Installs Above Threshold |
metric |
|
Order Type |
Order Type |
The category of the transaction, such as new purchase, update, or refund. |
dimension |
Period |
Period |
The reporting frequency or period for the data (e.g., Daily, Weekly, Monthly, Yearly). |
dimension |
Proceeds Reason |
Proceeds Reason |
Indicates the specific transaction type or event that contributes to a particular proceed entry within financial reports, such as a sale, refund, or other adjustments related to app transactions. |
dimension |
Product Type Identifier |
Product Type Identifier |
A unique identifier classifying the type of product (e.g., app, in-app purchase). |
dimension |
Promo Code |
Promo Code |
Alphanumeric codes that provide free or discounted access to auto-renewable subscriptions or apps for a specific duration, used for promotional campaigns. Note that Apple is transitioning from ‘Promo Codes’ to ‘Offer Codes’ for in-app purchases. |
dimension |
Provider |
Provider |
The unique identifier associated with the content provider or developer account in App Store Connect, often referred to as the Vendor Number in sales reports. |
dimension |
Provider Country |
Provider Country |
This field indicates the country or territory associated with app installs or sales. Data can be retrieved from the App Store Connect API through Sales and Trends Reports, utilizing the SUMMARY_TERRITORY subtype for INSTALLS or SALES report types, enabling geographic performance analysis. |
dimension |
Response Body |
Response Body |
The content of the developer’s response to a customer review. |
dimension |
Response ID |
Response ID |
A unique identifier for the developer’s response to a customer review. |
dimension |
Response Last Modified Date |
Response Last Modified Date |
The date and time when the developer’s response to a customer review was last modified. |
dimension |
Response Last Modified Date (Date) |
Response Last Modified Date (Date) |
The date when the developer’s response to a customer review was last modified. |
dimension |
Response State |
Response State |
The current publication state of the developer’s response (e.g., PUBLISHED, PENDING). |
dimension |
Review Body |
Review Body |
The full text content that the customer wrote for the review. |
dimension |
Review Created Date |
Review Created Date |
The date and time when the customer originally created the review. |
dimension |
Review Created Date (Date) |
Review Created Date (Date) |
The date when the customer originally created the review, without the time component. |
dimension |
Review ID |
Review ID |
A unique identifier for the customer review. |
dimension |
Review Rating |
Review Rating |
The numerical rating (1-5 stars) that the customer provided for the app. |
metric |
Review Territory |
Review Territory |
The App Store territory (e.g., ‘USA’, ‘JPN’) where the review was submitted. |
dimension |
Review Title |
Review Title |
The title or subject line that the customer wrote for the review. |
dimension |
Reviewer Nickname |
Reviewer Nickname |
The nickname or username used by the customer when submitting the review. |
dimension |
SKU |
SKU |
A unique Stock Keeping Unit identifier for a specific product or version of the app. |
dimension |
Subscription |
Subscription |
Details related to an app subscription, if the report type is ‘Subscriber’. |
dimension |
Supported Platforms |
Supported Platforms |
The platforms (e.g., iOS, macOS) that the application supports. |
dimension |
Territory |
Territory |
The geographical region or country where an app install or sale occurred, available as a report sub-type for install reports and in financial reports. |
dimension |
Title |
Title |
The title provided by a customer for their review of the application on the App Store. |
dimension |
Units |
Units |
The quantity of items sold or downloaded (e.g., app installs, in-app purchases). |
metric |
Version |
Version |
The version number of the application or the report version. |
dimension |