Appstore
:::warning
Deprecation notice
The Appstore source connector is scheduled for deprecation on 5 March 2024. It is incompatible with upcoming platform updates for Airbyte 1.0. After deprecation, it will no longer be supported or available in Airbyte.
This connector doesn’t support new per-stream features that protect data integrity during Airbyte synchronisation. Without them, Airbyte cannot enforce its reliability and correctness standards for data syncing operations.
Recommended actions
To continue syncing data from this source, consider creating a custom connector. For guidance, visit Custom Connector documentation.
:::
Sync overview
This source can sync data for the Appstore API using Incremental syncs only. The Appstore API is available for many types of services. It currently supports syncing Sales and Trends reports. To sync data from other endpoints, create an issue on Github.
This Source Connector is based on a Singer Tap.
Output schema
You can sync the following “Sales and Trends” Streams with this Source:
Your credentials may only allow you to sync some of these reports. For example, you can’t sync subscription-related reports if your app doesn’t offer subscriptions.
Data type mapping
| Integration Type | Airbyte Type | Notes |
|---|---|---|
string | string | |
int, float, number | number | |
date | date | |
datetime | datetime | |
array | array | |
object | object |
Features
| Feature | Supported?(Yes/No) | Notes |
|---|---|---|
| Full Refresh Sync | no | |
| Incremental Sync | yes | |
| Namespaces | No |
Performance considerations
The connector is subject to standard Appstore requests limitation.
Under normal use, the Appstore connector shouldn’t reach Appstore API limits. Please create an issue if any rate limit issues aren’t retried successfully.
The API may not have data available for your requested period. This can happen when you request data older than 365 days. Today’s or yesterday’s data may also not yet be available to request.
Getting started
Requirements
- Key ID
- Private Key: The contents of the private API key file in P8 format. It should start with
-----BEGIN PRIVATE KEY-----and end with-----END PRIVATE KEY-----. - Issuer ID
- Vendor ID: Go to “Sales and Trends”, then choose “Reports” from the top-left drop-down menu. On the next screen, open the “Vendor” drop-down menu. Your name and ID will appear there. Use the numeric Vendor ID.
- Start Date (The date used for the first sync. Apple only allows you to go back 365 days from today.) Example:
2020-11-16T00:00:00Z
Setup guide
Use this external article to generate or find all requirements.
IP allow list
If you use Airbyte Cloud and your organisation restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.