Advanced Analytica Advanced Analytica: IBOM
← All connectors
App Store Connect logo

Source connector

App Store Connect

Set up App Store Connect as a source and move its data into your chosen destination.

Version 0.0.10 community alpha

App Store Connect

The App Store Connect source replicates app metadata, customer reviews, Sales and Trends reports, finance reports and App Store Analytics reports from App Store Connect API.

Before you start

  • An App Store Connect team API key. Apple’s individual API keys can’t access Sales and Trends or finance reports, so the connector doesn’t support them.
  • The key’s issuer ID, key ID and downloaded .p8 private key.
  • Your vendor number, required by the Sales and Trends and finance report endpoints.
  • An API key role covering every report family you plan to sync. See Choose a role for the API key.
  • An existing analytics report request for each app whose analytics data you want to sync. The connector reads existing ONGOING and ONE_TIME_SNAPSHOT requests but doesn’t create them.

Set up the connector

Create a team API key

You need the Admin role in App Store Connect to create team keys.

  1. In App Store Connect, go to Users and Access > Integrations > App Store Connect API.
  2. On the Team Keys tab, click Generate API Key (or +).
  3. Enter a name, choose a role under Access and click Generate.
  4. Copy the Issuer ID shown at the top of the page and the new key’s Key ID.
  5. Click Download API Key and save the .p8 file. Apple only lets you download the private key once and doesn’t keep a copy.

When configuring the connector, paste the complete .p8 file contents into JWT Secret Key. Include the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- lines.

See Creating API Keys for App Store Connect API for Apple’s instructions.

Choose an API key role

Your key’s role determines which streams return data. Streams that the key can’t access sync as empty instead of failing.

  • Sales and Reports: Apple’s recommended role for third-party reporting tools. It can read Sales and Trends and analytics reports, but not finance reports. With this role, finance_report is empty.
  • Finance: Can read analytics and finance reports.
  • Admin: Can read everything. It’s the only role that can create analytics report requests.

See Downloading Analytics Reports for Apple’s role table.

Find your vendor number

In App Store Connect, open Payments and Financial Reports and copy the vendor number shown there. Enter it in the vendorID field.

Create analytics requests

Analytics streams only return data for apps with an existing analytics report request. You can only create these requests through Apple’s API. The POST /v1/analyticsReportRequests endpoint requires the Admin role. Create an ONGOING request for each app you want to sync daily. You can also create a ONE_TIME_SNAPSHOT request for historical data. See Request reports.

Apple takes one to two days to produce the first reports after you create a request. It doesn’t backfill ONGOING reports from before the request’s creation date. Set Analytics reports start date to the request’s creation date or later.

If nobody downloads reports for an extended period, Apple changes the request’s status to stoppedDueToInactivity and stops generating reports. Create a new request to resume reporting.

Configuration

InputRequiredDescription
issYesIssuer ID for the App Store Connect team API key.
kidYesKey ID for the App Store Connect API key.
secret_keyYesComplete .p8 private key. The connector uses it to sign ES256 JWTs.
vendorIDYesYour vendor number from Payments and Financial Reports.
analytics_reports_start_dateYesEarliest processing date to read for the ongoing analytics streams, in YYYY-MM-DD format. Use the ONGOING request creation date or later.
reviews_start_dateNoEarliest customer review creation time to read, in UTC YYYY-MM-DDTHH:MM:SSZ format. Defaults to 2020-01-01T00:00:00Z.
sales_reports_start_dateNoEarliest daily report date for sales_report, subscriber_report, and subscription_report, in YYYY-MM-DD format. Defaults to 365 days before the sync. Dates older than 365 days are moved forward to Apple’s retention limit.
subscription_event_reports_start_dateNoEarliest daily report date for subscription_event_report, in YYYY-MM-DD format. Independent of sales_reports_start_date. Defaults to 365 days before the sync.
subscription_event_skip_datesNoReport dates (YYYY-MM-DD) to skip for subscription_event_report. Use this when Apple returns an archive for a specific day that can’t be decoded. The connector advances past skipped dates without emitting rows.
finance_reports_start_dateNoEarliest finance report month, in YYYY-MM format. Defaults to 11 months before the current month. Months older than that are moved forward to Apple’s retention limit.

Streams

Apps and reviews

StreamSync modeDescription
list_id_appsFull refreshApps visible to the API key. Parent stream for every other stream that’s scoped to an app.
customer_reviews_per_appIncrementalCustomer reviews for each app, flattened to include rating, title, body, reviewerNickname, territory, createdDate, and app_id. Cursor: createdDate. Each sync re-reads the last seven days to pick up late-arriving reviews.

For each report date, every stream downloads one daily gzip TSV report from the salesReports endpoint. It emits one record for each row. The connector adds a report_date field containing the report date. It also adds a _sync_cursor field for incremental state.

StreamSync modeApple reportDescription
sales_reportIncrementalSALES, SUMMARY, version 1_1Daily sales summary. The most recent report date requested is two days before the sync.
subscriber_reportIncrementalSUBSCRIBER, DETAILED, version 1_3Daily subscriber detail. The most recent report date requested is two days before the sync.
subscription_reportIncrementalSUBSCRIPTION, SUMMARY, version 1_3Daily subscription summary. The most recent report date requested is two days before the sync.
subscription_event_reportIncrementalSUBSCRIPTION_EVENT, SUMMARY, version 1_3Daily subscription event summary. The most recent report date requested is three days before the sync, because Apple finalizes event data later than other reports.

Finance reports

StreamSync modeDescription
finance_reportIncrementalMonthly FINANCIAL report for region ZZ (all regions, consolidated). Syncs through the month that ended at least 35 days ago, which is when Apple has typically published it. Requires the Finance or Admin role.

App Store Analytics reports

Apple produces analytics data through this hierarchy: report request > report > instance > segment > downloaded file. The connector exposes every level, helping you audit what Apple generated. Streams ending in _historical read ONE_TIME_SNAPSHOT requests. All other streams read ONGOING requests.

The connector reads two Apple reports: App Store Installation and Deletion Standard and App Downloads Standard. Both use DAILY granularity. Other analytics reports aren’t supported.

StreamSync modeDescription
analytics_report_requests_ongoingFull refreshONGOING report requests for each app.
analytics_installations_reportsFull refreshThe Installation and Deletion report for each ongoing request.
analytics_installations_instancesIncrementalDaily instances of the Installation and Deletion report. Cursor: processing_date.
analytics_installations_segmentsIncrementalSegments for each instance, with each segment’s checksum, sizeInBytes, and url. Cursor: processing_date.
analytics_installations_segment_detailsFull refreshMetadata for each segment, including the pre-signed download_url.
app_store_installations_and_deletionsIncrementalRows from the downloaded Installation and Deletion report files. Cursor: processing_date.
analytics_app_download_reportsFull refreshThe App Downloads report for each ongoing request.
analytics_app_download_instancesIncrementalDaily instances of the App Downloads report. Cursor: processing_date.
analytics_app_download_segmentsIncrementalSegments for each instance, with each segment’s checksum, sizeInBytes, and url. Cursor: processing_date.
analytics_app_download_segment_detailsFull refreshMetadata for each segment, including the pre-signed download_url.
app_downloadIncrementalRows from the downloaded App Downloads report files. Cursor: processing_date.
analytics_report_requests_historicalFull refreshONE_TIME_SNAPSHOT report requests for each app.
analytics_installations_reports_historicalFull refreshThe Installation and Deletion report for each snapshot request.
analytics_installations_instances_historicalFull refreshInstances of the historical Installation and Deletion report.
analytics_installations_segments_historicalFull refreshSegments of the historical Installation and Deletion report.
analytics_installations_segment_details_historicalFull refreshSegment metadata for the historical Installation and Deletion report.
app_store_installations_and_deletions_historicalFull refreshRows from the downloaded historical Installation and Deletion report files.
analytics_app_download_reports_historicalFull refreshThe App Downloads report for each snapshot request.
analytics_app_download_instances_historicalFull refreshInstances of the historical App Downloads report.
analytics_app_download_segments_historicalFull refreshSegments of the historical App Downloads report.
analytics_app_download_segment_details_historicalFull refreshSegment metadata for the historical App Downloads report.
app_download_historicalFull refreshRows from the downloaded historical App Downloads report files.

Incremental analytics streams read each processing date from analytics_reports_start_date, or the saved cursor, until two days before the sync. The app_download and app_store_installations_and_deletions streams download each segment’s gzip TSV file from Apple’s short-lived pre-signed Amazon S3 URL. They emit one record for each row.

Limits and data availability

  • Sales and Trends reports are available only within Apple’s rolling 365-day retention window. The connector never requests older dates, even when you set an earlier start date.
  • Finance reports cover roughly the latest 11 months and end with the latest complete fiscal month.
  • ONGOING analytics requests don’t backfill data from before their creation date. For earlier data, use a ONE_TIME_SNAPSHOT request and the _historical streams.
  • A report stream returns empty instead of failing in three cases. The API key’s role can’t access the report, the app doesn’t produce it, or Apple hasn’t published the requested period. Sales and Trends and finance streams treat 400, 404 and 410 responses as “no data”. Analytics streams also treat 403 that way.
  • The connector runs analytics download jobs one at a time.

Rate limits

Apple gives each API key an hourly request budget. You can find it in the X-Rate-Limit response header. See Identifying Rate Limits. The connector retries 429 and transient 5xx responses up to three times, using exponential backoff.

Authentication

The connector signs a new ES256 JWT for every App Store Connect request. Each JWT has a 15-minute lifetime and the appstoreconnect-v1 audience. Analytics report downloads use Apple’s pre-signed S3 URLs and don’t include the JWT.

IP allow list

If you use Airbyte Cloud and restrict access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Changelog

Expand to review
VersionDatePull RequestSubject
0.0.102026-11-1191545Request 200 records per page for apps and analytics report listings, and declare the analytics segment fields in the segments stream schemas
0.0.92026-11-1091343Update dependencies
0.0.82026-11-0390446Update dependencies
0.0.72026-10-2789802Update dependencies
0.0.62026-10-2089119Update dependencies
0.0.52026-10-1388542Update dependencies
0.0.42026-10-0687756Update dependencies
0.0.32026-09-2987078Update dependencies
0.0.22026-09-2286549Update dependencies
0.0.12026-09-1685821Initial release by @Ella6882 via Connector Builder
Advanced Analytica

Most businesses are sitting on information they can’t use at speed. The people who hold it are busy, and when they leave, the knowledge goes with them. The documents are static, and the processes around them weren’t designed for AI.

Advanced Analytica works with these businesses to turn that information into structured data assets. Once they're integrated, AI systems can govern it, and the business can use it. We bring in the strategy, the specification and the AI skills to rework how the business operates.

MOVE FAST. STAY SAFE.