Appstore [ARCHIVED]
Deprecation Notice
The Appstore source connector is scheduled for deprecation on March 5th, 2024 due to incompatibility with upcoming platform updates as we prepare to launch Airbyte 1.0. This means it will no longer be supported or available for use in Airbyte.
This connector does not support new per-stream features which are vital for ensuring data integrity in Airbyte's synchronization processes. Without these capabilities, we cannot enforce our standards of reliability and correctness for data syncing operations.
Recommended Actions
Users who still wish to sync data from this connector are advised to explore creating a custom connector as an alternative to continue their data synchronization needs. For guidance, please visit our Custom Connector documentation.
Sync overview
This source can sync data for the Appstore API. It supports only Incremental syncs. The Appstore API is available for many types of services. Currently, this API supports syncing Sales and Trends reports. If you'd like to sync data from other endpoints, please create an issue on Github.
This Source Connector is based on a Singer Tap.
Output schema
This Source is capable of syncing the following "Sales and Trends" Streams:
Note that depending on the credentials you enter, you may only be able to sync some of these reports. For example, if your app does not offer subscriptions, then it is not possible to sync subscription related reports.
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 restricted by normal Appstore requests limitation.
The Appstore connector should not run into Appstore API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
One issue that can happen is the API not having the data available for the period requested, either because you're trying to request data older than 365 days or the today's and yesterday's data was not yet made available to be requested.
Getting started
Requirements
- Key ID
- Private Key The contents of the private API key file, which is in the P8 format and 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 drop-down menu in the top left. On the next screen, there'll be a drop-down menu for "Vendor". Your name and ID will be shown there. Use the numeric Vendor ID.
- Start Date (The date that will be used in the first sync. Apple only allows to go back 365 days from today.) Example:
2020-11-16T00:00:00Z
Setup guide
Generate/Find all requirements using this external article.