Loading Data from Apple App-Store Connect to EDB BigAnimal with dlt in Python
tip
We will be using the dlt PostgreSQL destination to connect to EDB BigAnimal. You can get the connection string for your EDB BigAnimal database as described in the EDB BigAnimal Docs.
Need help deploying these pipelines, or figuring out how to run them in your data stack?
Join our Slack community or book a call with our support engineer Violetta.
Loading data from Apple App-Store Connect to EDB BigAnimal can streamline your app monitoring and database management processes. Apple App-Store Connect allows you to track app sales and downloads, respond to reviews, and receive notifications about new reviews. EDB BigAnimal is a fully managed database-as-a-service that simplifies setting up, managing, and scaling your databases, whether using PostgreSQL or EDB Postgres Advanced Server. By leveraging the open-source Python library dlt, you can efficiently transfer data from Apple App-Store Connect to EDB BigAnimal. This integration enables you to harness the power of EDB BigAnimal's high-availability cluster types and Oracle compatibility features. For more information on Apple App-Store Connect, visit this link.
dlt Key Features
- Easy to get started:
dltis a Python library that is easy to use and understand. It is designed to be simple to use and easy to understand. Typepip install dltand you are ready to go. - Scalability via iterators, chunking, and parallelization:
dltoffers scalable data extraction by leveraging iterators, chunking, and parallelization techniques. This approach allows for efficient processing of large datasets by breaking them down into manageable chunks. Read more - Pipeline Metadata:
dltpipelines leverage metadata to provide governance capabilities. This metadata includes load IDs, which consist of a timestamp and pipeline name. Load IDs enable incremental transformations and data vaulting by tracking data loads and facilitating data lineage and traceability. Read more - Schema Enforcement and Curation:
dltempowers users to enforce and curate schemas, ensuring data consistency and quality. Schemas define the structure of normalized data and guide the processing and loading of data. Read more - Implicit extraction DAGs:
dltincorporates the concept of implicit extraction DAGs to handle the dependencies between data sources and their transformations automatically. This extraction DAG determines the optimal order for extracting the resources to ensure data consistency and integrity. Read more
Getting started with your pipeline locally
dlt-init-openapi0. Prerequisites
dlt and dlt-init-openapi requires Python 3.9 or higher. Additionally, you need to have the pip package manager installed, and we recommend using a virtual environment to manage your dependencies. You can learn more about preparing your computer for dlt in our installation reference.
1. Install dlt and dlt-init-openapi
First you need to install the dlt-init-openapi cli tool.
pip install dlt-init-openapi
The dlt-init-openapi cli is a powerful generator which you can use to turn any OpenAPI spec into a dlt source to ingest data from that api. The quality of the generator source is dependent on how well the API is designed and how accurate the OpenAPI spec you are using is. You may need to make tweaks to the generated code, you can learn more about this here.
# generate pipeline
# NOTE: add_limit adds a global limit, you can remove this later
# NOTE: you will need to select which endpoints to render, you
# can just hit Enter and all will be rendered.
dlt-init-openapi apple_app_store_connect --url https://api.apis.guru/v2/specs/apple.com/app-store-connect/1.4.1/openapi.yaml --global-limit 2
cd apple_app_store_connect_pipeline
# install generated requirements
pip install -r requirements.txt
The last command will install the required dependencies for your pipeline. The dependencies are listed in the requirements.txt:
dlt>=0.4.12
You now have the following folder structure in your project:
apple_app_store_connect_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── rest_api/ # The rest api verified source
│ └── ...
├── apple_app_store_connect/
│ └── __init__.py # TODO: possibly tweak this file
├── apple_app_store_connect_pipeline.py # your main pipeline script
├── requirements.txt # dependencies for your pipeline
└── .gitignore # ignore files for git (not required)
1.1. Tweak apple_app_store_connect/__init__.py
This file contains the generated configuration of your rest_api. You can continue with the next steps and leave it as is, but you might want to come back here and make adjustments if you need your rest_api source set up in a different way. The generated file for the apple_app_store_connect source will look like this:
Click to view full file (2564 lines)
from typing import List
import dlt
from dlt.extract.source import DltResource
from rest_api import rest_api_source
from rest_api.typing import RESTAPIConfig
@dlt.source(name="apple_app_store_connect_source", max_table_nesting=2)
def apple_app_store_connect_source(
token: str = dlt.secrets.value,
base_url: str = dlt.config.value,
) -> List[DltResource]:
# source configuration
source_config: RESTAPIConfig = {
"client": {
"base_url": base_url,
"auth": {
"type": "bearer",
"token": token,
},
"paginator": {
"type":
"json_response",
"next_url_path":
"links.next",
},
},
"resources":
[
{
"name": "app_infos_age_rating_declaration_get_to_one_related",
"table_name": "age_rating_declaration_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appInfos/{id}/ageRatingDeclaration",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[ageRatingDeclarations]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_versions_age_rating_declaration_get_to_one_related",
"table_name": "age_rating_declaration_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreVersions/{id}/ageRatingDeclaration",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[ageRatingDeclarations]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_encryption_declarations_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appEncryptionDeclarations/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "app_encryption_declarations_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_get_collection",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps",
}
},
{
"name": "apps_beta_app_review_detail_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/apps/{id}/betaAppReviewDetail",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaAppReviewDetails]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_beta_license_agreement_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/apps/{id}/betaLicenseAgreement",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaLicenseAgreements]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_app_localizations_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/betaAppLocalizations/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "beta_app_localizations_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_app_review_details_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/betaAppReviewDetails/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "beta_app_review_details_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_groups_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/betaGroups/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "beta_groups_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_license_agreements_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/betaLicenseAgreements/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "beta_license_agreements_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_testers_apps_get_to_many_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaTesters/{id}/apps",
"params": {
"id": {
"type": "resolve",
"resource": "beta_testers_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_testers_apps_get_to_many_relationship",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaTesters/{id}/relationships/apps",
"params": {
"id": {
"type": "resolve",
"resource": "beta_testers_get_collection",
"field": "id",
},
},
}
},
{
"name": "builds_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/builds/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "builds_app_encryption_declaration_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/builds/{id}/appEncryptionDeclaration",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appEncryptionDeclarations]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "bundle_ids_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/bundleIds/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "bundle_ids_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "pre_release_versions_app_get_to_one_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/preReleaseVersions/{id}/app",
"params": {
"id": {
"type": "resolve",
"resource": "pre_release_versions_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "user_invitations_visible_apps_get_to_many_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/userInvitations/{id}/visibleApps",
"params": {
"id": {
"type": "resolve",
"resource": "user_invitations_get_collection",
"field": "id",
},
},
}
},
{
"name": "users_visible_apps_get_to_many_related",
"table_name": "app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/users/{id}/visibleApps",
"params": {
"id": {
"type": "resolve",
"resource": "users_get_collection",
"field": "id",
},
},
}
},
{
"name": "app_categories_get_collection",
"table_name": "app_category",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appCategories",
}
},
{
"name": "app_categories_subcategories_get_to_many_related",
"table_name": "app_category",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appCategories/{id}/subcategories",
"params": {
"id": {
"type": "resolve",
"resource": "app_categories_get_collection",
"field": "id",
},
},
}
},
{
"name": "app_categories_get_instance",
"table_name": "app_category_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appCategories/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "app_categories_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "limit[subcategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_encryption_declarations_get_collection",
"table_name": "app_encryption_declaration",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appEncryptionDeclarations",
}
},
{
"name": "app_encryption_declarations_get_instance",
"table_name": "app_encryption_declaration_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appEncryptionDeclarations/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "app_encryption_declarations_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appEncryptionDeclarations]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_app_infos_get_to_many_related",
"table_name": "app_info",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/appInfos",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "app_infos_app_info_localizations_get_to_many_related",
"table_name": "app_info_localization",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appInfos/{id}/appInfoLocalizations",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_info_localizations_get_instance",
"table_name": "app_info_localization_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appInfoLocalizations/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appInfoLocalizations]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_infos_get_instance",
"table_name": "app_info_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appInfos/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appInfos]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[ageRatingDeclarations]": "OPTIONAL_CONFIG",
# "fields[appCategories]": "OPTIONAL_CONFIG",
# "fields[appInfoLocalizations]": "OPTIONAL_CONFIG",
# "limit[appInfoLocalizations]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_pre_orders_get_instance",
"table_name": "app_pre_order_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appPreOrders/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appPreOrders]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_pre_order_get_to_one_related",
"table_name": "app_pre_order_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/apps/{id}/preOrder",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appPreOrders]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_preview_sets_app_previews_get_to_many_related",
"table_name": "app_preview",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appPreviewSets/{id}/appPreviews",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_preview_sets_app_previews_get_to_many_relationship",
"table_name": "app_preview",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appPreviewSets/{id}/relationships/appPreviews",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_previews_get_instance",
"table_name": "app_preview_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appPreviews/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appPreviews]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_version_localizations_app_preview_sets_get_to_many_related",
"table_name": "app_preview_set",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appStoreVersionLocalizations/{id}/appPreviewSets",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_preview_sets_get_instance",
"table_name": "app_preview_set_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appPreviewSets/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appPreviewSets]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[appPreviews]": "OPTIONAL_CONFIG",
# "limit[appPreviews]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_prices_get_to_many_related",
"table_name": "app_price",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/prices",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "app_price_points_get_collection",
"table_name": "app_price_point",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appPricePoints",
}
},
{
"name": "app_price_tiers_price_points_get_to_many_related",
"table_name": "app_price_point",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appPriceTiers/{id}/pricePoints",
"params": {
"id": {
"type": "resolve",
"resource": "app_price_tiers_get_collection",
"field": "id",
},
},
}
},
{
"name": "app_price_points_get_instance",
"table_name": "app_price_point_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appPricePoints/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "app_price_points_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appPricePoints]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[territories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_prices_get_instance",
"table_name": "app_price_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appPrices/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appPrices]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_price_tiers_get_collection",
"table_name": "app_price_tier",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appPriceTiers",
}
},
{
"name": "app_price_tiers_get_instance",
"table_name": "app_price_tier_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appPriceTiers/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "app_price_tiers_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appPriceTiers]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[appPricePoints]": "OPTIONAL_CONFIG",
# "limit[pricePoints]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_get_instance",
"table_name": "app_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/apps/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[apps]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[betaGroups]": "OPTIONAL_CONFIG",
# "fields[perfPowerMetrics]": "OPTIONAL_CONFIG",
# "fields[appInfos]": "OPTIONAL_CONFIG",
# "fields[appPreOrders]": "OPTIONAL_CONFIG",
# "fields[preReleaseVersions]": "OPTIONAL_CONFIG",
# "fields[appPrices]": "OPTIONAL_CONFIG",
# "fields[inAppPurchases]": "OPTIONAL_CONFIG",
# "fields[betaAppReviewDetails]": "OPTIONAL_CONFIG",
# "fields[territories]": "OPTIONAL_CONFIG",
# "fields[gameCenterEnabledVersions]": "OPTIONAL_CONFIG",
# "fields[appStoreVersions]": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
# "fields[betaAppLocalizations]": "OPTIONAL_CONFIG",
# "fields[betaLicenseAgreements]": "OPTIONAL_CONFIG",
# "fields[endUserLicenseAgreements]": "OPTIONAL_CONFIG",
# "limit[appInfos]": "OPTIONAL_CONFIG",
# "limit[appStoreVersions]": "OPTIONAL_CONFIG",
# "limit[availableTerritories]": "OPTIONAL_CONFIG",
# "limit[betaAppLocalizations]": "OPTIONAL_CONFIG",
# "limit[betaGroups]": "OPTIONAL_CONFIG",
# "limit[builds]": "OPTIONAL_CONFIG",
# "limit[gameCenterEnabledVersions]": "OPTIONAL_CONFIG",
# "limit[inAppPurchases]": "OPTIONAL_CONFIG",
# "limit[preReleaseVersions]": "OPTIONAL_CONFIG",
# "limit[prices]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_screenshot_sets_app_screenshots_get_to_many_related",
"table_name": "app_screenshot",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appScreenshotSets/{id}/appScreenshots",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_screenshot_sets_app_screenshots_get_to_many_relationship",
"table_name": "app_screenshot",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appScreenshotSets/{id}/relationships/appScreenshots",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_screenshots_get_instance",
"table_name": "app_screenshot_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appScreenshots/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appScreenshots]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_version_localizations_app_screenshot_sets_get_to_many_related",
"table_name": "app_screenshot_set",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appStoreVersionLocalizations/{id}/appScreenshotSets",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_screenshot_sets_get_instance",
"table_name": "app_screenshot_set_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appScreenshotSets/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appScreenshotSets]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[appScreenshots]": "OPTIONAL_CONFIG",
# "limit[appScreenshots]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_review_details_app_store_review_attachments_get_to_many_related",
"table_name": "app_store_review_attachment",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appStoreReviewDetails/{id}/appStoreReviewAttachments",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_store_versions_app_store_review_detail_get_to_one_related",
"table_name": "app_store_review_attachment",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appStoreVersions/{id}/appStoreReviewDetail",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appStoreReviewDetails]": "OPTIONAL_CONFIG",
# "fields[appStoreVersions]": "OPTIONAL_CONFIG",
# "fields[appStoreReviewAttachments]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_review_attachments_get_instance",
"table_name": "app_store_review_attachment_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreReviewAttachments/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appStoreReviewAttachments]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_review_details_get_instance",
"table_name": "app_store_review_detail_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreReviewDetails/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appStoreReviewDetails]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[appStoreReviewAttachments]": "OPTIONAL_CONFIG",
# "limit[appStoreReviewAttachments]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_app_store_versions_get_to_many_related",
"table_name": "app_store_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/appStoreVersions",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "builds_app_store_version_get_to_one_related",
"table_name": "app_store_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/builds/{id}/appStoreVersion",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appStoreVersions]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_versions_build_get_to_one_relationship",
"table_name": "app_store_version_build_linkage_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreVersions/{id}/relationships/build",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_store_versions_app_store_version_localizations_get_to_many_related",
"table_name": "app_store_version_localization",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/appStoreVersions/{id}/appStoreVersionLocalizations",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_store_version_localizations_get_instance",
"table_name": "app_store_version_localization_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreVersionLocalizations/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appStoreVersionLocalizations]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[appScreenshotSets]": "OPTIONAL_CONFIG",
# "fields[appPreviewSets]": "OPTIONAL_CONFIG",
# "limit[appPreviewSets]": "OPTIONAL_CONFIG",
# "limit[appScreenshotSets]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_versions_app_store_version_phased_release_get_to_one_related",
"table_name": "app_store_version_phased_release_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreVersions/{id}/appStoreVersionPhasedRelease",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appStoreVersionPhasedReleases]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_versions_get_instance",
"table_name": "app_store_version_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreVersions/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appStoreVersions]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[appStoreVersionLocalizations]": "OPTIONAL_CONFIG",
# "fields[idfaDeclarations]": "OPTIONAL_CONFIG",
# "fields[routingAppCoverages]": "OPTIONAL_CONFIG",
# "fields[appStoreVersionPhasedReleases]": "OPTIONAL_CONFIG",
# "fields[ageRatingDeclarations]": "OPTIONAL_CONFIG",
# "fields[appStoreReviewDetails]": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
# "fields[appStoreVersionSubmissions]": "OPTIONAL_CONFIG",
# "limit[appStoreVersionLocalizations]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_versions_app_store_version_submission_get_to_one_related",
"table_name": "app_store_version_submission_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreVersions/{id}/appStoreVersionSubmission",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appStoreVersions]": "OPTIONAL_CONFIG",
# "fields[appStoreVersionSubmissions]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_beta_app_localizations_get_to_many_related",
"table_name": "beta_app_localization",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/betaAppLocalizations",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_app_localizations_get_collection",
"table_name": "beta_app_localization",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaAppLocalizations",
}
},
{
"name": "beta_app_localizations_get_instance",
"table_name": "beta_app_localization_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/betaAppLocalizations/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "beta_app_localizations_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaAppLocalizations]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_app_review_details_get_collection",
"table_name": "beta_app_review_detail",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaAppReviewDetails",
}
},
{
"name": "beta_app_review_details_get_instance",
"table_name": "beta_app_review_detail_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/betaAppReviewDetails/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "beta_app_review_details_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaAppReviewDetails]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_app_review_submissions_get_collection",
"table_name": "beta_app_review_submission",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaAppReviewSubmissions",
}
},
{
"name": "beta_app_review_submissions_get_instance",
"table_name": "beta_app_review_submission_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/betaAppReviewSubmissions/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "beta_app_review_submissions_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaAppReviewSubmissions]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_build_localizations_get_collection",
"table_name": "beta_build_localization",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaBuildLocalizations",
}
},
{
"name": "builds_beta_build_localizations_get_to_many_related",
"table_name": "beta_build_localization",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/builds/{id}/betaBuildLocalizations",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_build_localizations_get_instance",
"table_name": "beta_build_localization_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/betaBuildLocalizations/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "beta_build_localizations_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaBuildLocalizations]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_beta_groups_get_to_many_related",
"table_name": "beta_group",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/betaGroups",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_groups_get_collection",
"table_name": "beta_group",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaGroups",
}
},
{
"name": "beta_testers_beta_groups_get_to_many_related",
"table_name": "beta_group",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaTesters/{id}/betaGroups",
"params": {
"id": {
"type": "resolve",
"resource": "beta_testers_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_testers_beta_groups_get_to_many_relationship",
"table_name": "beta_group",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaTesters/{id}/relationships/betaGroups",
"params": {
"id": {
"type": "resolve",
"resource": "beta_testers_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_groups_get_instance",
"table_name": "beta_group_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/betaGroups/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "beta_groups_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaGroups]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
# "fields[betaTesters]": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
# "limit[betaTesters]": "OPTIONAL_CONFIG",
# "limit[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_license_agreements_get_collection",
"table_name": "beta_license_agreement",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaLicenseAgreements",
}
},
{
"name": "beta_license_agreements_get_instance",
"table_name": "beta_license_agreement_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/betaLicenseAgreements/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "beta_license_agreements_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaLicenseAgreements]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_groups_beta_testers_get_to_many_related",
"table_name": "beta_tester",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaGroups/{id}/betaTesters",
"params": {
"id": {
"type": "resolve",
"resource": "beta_groups_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_groups_beta_testers_get_to_many_relationship",
"table_name": "beta_tester",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaGroups/{id}/relationships/betaTesters",
"params": {
"id": {
"type": "resolve",
"resource": "beta_groups_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_testers_get_collection",
"table_name": "beta_tester",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaTesters",
}
},
{
"name": "builds_individual_testers_get_to_many_related",
"table_name": "beta_tester",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/builds/{id}/individualTesters",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_testers_get_instance",
"table_name": "beta_tester_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/betaTesters/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "beta_testers_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaTesters]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[betaGroups]": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
# "limit[apps]": "OPTIONAL_CONFIG",
# "limit[betaGroups]": "OPTIONAL_CONFIG",
# "limit[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_versions_build_get_to_one_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appStoreVersions/{id}/build",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_builds_get_to_many_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/builds",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_app_review_submissions_build_get_to_one_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/betaAppReviewSubmissions/{id}/build",
"params": {
"id": {
"type": "resolve",
"resource": "beta_app_review_submissions_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_build_localizations_build_get_to_one_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/betaBuildLocalizations/{id}/build",
"params": {
"id": {
"type": "resolve",
"resource": "beta_build_localizations_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "beta_groups_builds_get_to_many_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaGroups/{id}/builds",
"params": {
"id": {
"type": "resolve",
"resource": "beta_groups_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_groups_builds_get_to_many_relationship",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaGroups/{id}/relationships/builds",
"params": {
"id": {
"type": "resolve",
"resource": "beta_groups_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_testers_builds_get_to_many_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaTesters/{id}/builds",
"params": {
"id": {
"type": "resolve",
"resource": "beta_testers_get_collection",
"field": "id",
},
},
}
},
{
"name": "beta_testers_builds_get_to_many_relationship",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/betaTesters/{id}/relationships/builds",
"params": {
"id": {
"type": "resolve",
"resource": "beta_testers_get_collection",
"field": "id",
},
},
}
},
{
"name": "build_beta_details_build_get_to_one_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/buildBetaDetails/{id}/build",
"params": {
"id": {
"type": "resolve",
"resource": "build_beta_details_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "builds_get_collection",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/builds",
}
},
{
"name": "builds_beta_app_review_submission_get_to_one_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/builds/{id}/betaAppReviewSubmission",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[betaAppReviewSubmissions]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "builds_build_beta_detail_get_to_one_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/builds/{id}/buildBetaDetail",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[buildBetaDetails]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "pre_release_versions_builds_get_to_many_related",
"table_name": "build",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/preReleaseVersions/{id}/builds",
"params": {
"id": {
"type": "resolve",
"resource": "pre_release_versions_get_collection",
"field": "id",
},
},
}
},
{
"name": "builds_app_encryption_declaration_get_to_one_relationship",
"table_name": "build_app_encryption_declaration_linkage_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/builds/{id}/relationships/appEncryptionDeclaration",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
},
}
},
{
"name": "build_beta_details_get_collection",
"table_name": "build_beta_detail",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/buildBetaDetails",
}
},
{
"name": "build_beta_details_get_instance",
"table_name": "build_beta_detail_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/buildBetaDetails/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "build_beta_details_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[buildBetaDetails]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "builds_icons_get_to_many_related",
"table_name": "build_icon",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/builds/{id}/icons",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
},
}
},
{
"name": "builds_get_instance",
"table_name": "build_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/builds/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[builds]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[appEncryptionDeclarations]": "OPTIONAL_CONFIG",
# "fields[betaAppReviewSubmissions]": "OPTIONAL_CONFIG",
# "fields[buildBetaDetails]": "OPTIONAL_CONFIG",
# "fields[buildIcons]": "OPTIONAL_CONFIG",
# "fields[perfPowerMetrics]": "OPTIONAL_CONFIG",
# "fields[preReleaseVersions]": "OPTIONAL_CONFIG",
# "fields[appStoreVersions]": "OPTIONAL_CONFIG",
# "fields[diagnosticSignatures]": "OPTIONAL_CONFIG",
# "fields[betaTesters]": "OPTIONAL_CONFIG",
# "fields[betaBuildLocalizations]": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
# "limit[betaBuildLocalizations]": "OPTIONAL_CONFIG",
# "limit[icons]": "OPTIONAL_CONFIG",
# "limit[individualTesters]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "bundle_ids_get_collection",
"table_name": "bundle_id",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/bundleIds",
}
},
{
"name": "profiles_bundle_id_get_to_one_related",
"table_name": "bundle_id",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/profiles/{id}/bundleId",
"params": {
"id": {
"type": "resolve",
"resource": "profiles_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[bundleIds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "bundle_ids_bundle_id_capabilities_get_to_many_related",
"table_name": "bundle_id_capability",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/bundleIds/{id}/bundleIdCapabilities",
"params": {
"id": {
"type": "resolve",
"resource": "bundle_ids_get_collection",
"field": "id",
},
},
}
},
{
"name": "bundle_ids_get_instance",
"table_name": "bundle_id_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/bundleIds/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "bundle_ids_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[bundleIds]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[bundleIdCapabilities]": "OPTIONAL_CONFIG",
# "fields[profiles]": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
# "limit[bundleIdCapabilities]": "OPTIONAL_CONFIG",
# "limit[profiles]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "certificates_get_collection",
"table_name": "certificate",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/certificates",
}
},
{
"name": "profiles_certificates_get_to_many_related",
"table_name": "certificate",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/profiles/{id}/certificates",
"params": {
"id": {
"type": "resolve",
"resource": "profiles_get_collection",
"field": "id",
},
},
}
},
{
"name": "certificates_get_instance",
"table_name": "certificate_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/certificates/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "certificates_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[certificates]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "game_center_enabled_versions_compatible_versions_get_to_many_relationship",
"table_name": "compatible_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/gameCenterEnabledVersions/{id}/relationships/compatibleVersions",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "devices_get_collection",
"table_name": "device",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/devices",
}
},
{
"name": "profiles_devices_get_to_many_related",
"table_name": "device",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/profiles/{id}/devices",
"params": {
"id": {
"type": "resolve",
"resource": "profiles_get_collection",
"field": "id",
},
},
}
},
{
"name": "devices_get_instance",
"table_name": "device_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/devices/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "devices_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[devices]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "diagnostic_signatures_logs_get_to_many_related",
"table_name": "diagnostic_log",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/diagnosticSignatures/{id}/logs",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "builds_diagnostic_signatures_get_to_many_related",
"table_name": "diagnostic_signature",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/builds/{id}/diagnosticSignatures",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
},
}
},
{
"name": "end_user_license_agreements_get_instance",
"table_name": "end_user_license_agreement_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/endUserLicenseAgreements/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[endUserLicenseAgreements]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[territories]": "OPTIONAL_CONFIG",
# "limit[territories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "finance_reports_get_collection",
"table_name": "finance_report",
"endpoint": {
"path": "/v1/financeReports",
"params": {
"filter[regionCode]": "FILL_ME_IN", # TODO: fill in required query parameter
"filter[reportDate]": "FILL_ME_IN", # TODO: fill in required query parameter
"filter[reportType]": "FILL_ME_IN", # TODO: fill in required query parameter
"filter[vendorNumber]": "FILL_ME_IN", # TODO: fill in required query parameter
},
}
},
{
"name": "apps_game_center_enabled_versions_get_to_many_related",
"table_name": "game_center_enabled_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/gameCenterEnabledVersions",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "game_center_enabled_versions_compatible_versions_get_to_many_related",
"table_name": "game_center_enabled_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/gameCenterEnabledVersions/{id}/compatibleVersions",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "app_store_versions_idfa_declaration_get_to_one_related",
"table_name": "idfa_declaration_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appStoreVersions/{id}/idfaDeclaration",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[idfaDeclarations]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_in_app_purchases_get_to_many_related",
"table_name": "in_app_purchase",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/inAppPurchases",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "in_app_purchases_get_instance",
"table_name": "in_app_purchase_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/inAppPurchases/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[inAppPurchases]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "limit[apps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "builds_individual_testers_get_to_many_relationship",
"table_name": "individual_tester",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/builds/{id}/relationships/individualTesters",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
},
}
},
{
"name": "app_categories_parent_get_to_one_related",
"table_name": "parent",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appCategories/{id}/parent",
"params": {
"id": {
"type": "resolve",
"resource": "app_categories_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_perf_power_metrics_get_to_many_related",
"table_name": "perf_power_metric",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/perfPowerMetrics",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "builds_perf_power_metrics_get_to_many_related",
"table_name": "perf_power_metric",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/builds/{id}/perfPowerMetrics",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
},
}
},
{
"name": "builds_pre_release_version_get_to_one_related",
"table_name": "pre_release_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/builds/{id}/preReleaseVersion",
"params": {
"id": {
"type": "resolve",
"resource": "builds_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[preReleaseVersions]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_pre_release_versions_get_to_many_related",
"table_name": "prerelease_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/preReleaseVersions",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "pre_release_versions_get_collection",
"table_name": "prerelease_version",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/preReleaseVersions",
}
},
{
"name": "pre_release_versions_get_instance",
"table_name": "prerelease_version_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/preReleaseVersions/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "pre_release_versions_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[preReleaseVersions]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[builds]": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
# "limit[builds]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_infos_primary_category_get_to_one_related",
"table_name": "primary_category",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appInfos/{id}/primaryCategory",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_infos_primary_subcategory_one_get_to_one_related",
"table_name": "primary_subcategory_one",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appInfos/{id}/primarySubcategoryOne",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_infos_primary_subcategory_two_get_to_one_related",
"table_name": "primary_subcategory_two",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appInfos/{id}/primarySubcategoryTwo",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "bundle_ids_profiles_get_to_many_related",
"table_name": "profile",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/bundleIds/{id}/profiles",
"params": {
"id": {
"type": "resolve",
"resource": "bundle_ids_get_collection",
"field": "id",
},
},
}
},
{
"name": "profiles_get_collection",
"table_name": "profile",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/profiles",
}
},
{
"name": "profiles_get_instance",
"table_name": "profile_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/profiles/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "profiles_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[profiles]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[certificates]": "OPTIONAL_CONFIG",
# "fields[devices]": "OPTIONAL_CONFIG",
# "fields[bundleIds]": "OPTIONAL_CONFIG",
# "limit[certificates]": "OPTIONAL_CONFIG",
# "limit[devices]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "routing_app_coverages_get_instance",
"table_name": "routing_app_coverage_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/routingAppCoverages/{id}",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[routingAppCoverages]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
},
}
},
{
"name": "sales_reports_get_collection",
"table_name": "sales_report",
"endpoint": {
"path": "/v1/salesReports",
"params": {
"filter[frequency]": "FILL_ME_IN", # TODO: fill in required query parameter
"filter[reportSubType]": "FILL_ME_IN", # TODO: fill in required query parameter
"filter[reportType]": "FILL_ME_IN", # TODO: fill in required query parameter
"filter[vendorNumber]": "FILL_ME_IN", # TODO: fill in required query parameter
# the parameters below can optionally be configured
# "filter[reportDate]": "OPTIONAL_CONFIG",
# "filter[version]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_infos_secondary_category_get_to_one_related",
"table_name": "secondary_category",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appInfos/{id}/secondaryCategory",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_infos_secondary_subcategory_one_get_to_one_related",
"table_name": "secondary_subcategory_one",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appInfos/{id}/secondarySubcategoryOne",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_infos_secondary_subcategory_two_get_to_one_related",
"table_name": "secondary_subcategory_two",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/appInfos/{id}/secondarySubcategoryTwo",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[appCategories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "apps_available_territories_get_to_many_related",
"table_name": "territory",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/apps/{id}/availableTerritories",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
},
}
},
{
"name": "apps_end_user_license_agreement_get_to_one_related",
"table_name": "territory",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "included",
"path": "/v1/apps/{id}/endUserLicenseAgreement",
"params": {
"id": {
"type": "resolve",
"resource": "apps_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[endUserLicenseAgreements]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "end_user_license_agreements_territories_get_to_many_related",
"table_name": "territory",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/endUserLicenseAgreements/{id}/territories",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
},
}
},
{
"name": "territories_get_collection",
"table_name": "territory",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/territories",
}
},
{
"name": "app_price_points_territory_get_to_one_related",
"table_name": "territory_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/appPricePoints/{id}/territory",
"params": {
"id": {
"type": "resolve",
"resource": "app_price_points_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[territories]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "app_store_versions_routing_app_coverage_get_to_one_related",
"table_name": "upload_operation",
"endpoint": {
"data_selector": "data.attributes.uploadOperations",
"path": "/v1/appStoreVersions/{id}/routingAppCoverage",
"params": {
"id": "FILL_ME_IN", # TODO: fill in required path parameter
# the parameters below can optionally be configured
# "fields[routingAppCoverages]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "users_get_collection",
"table_name": "user",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/users",
}
},
{
"name": "user_invitations_get_collection",
"table_name": "user_invitation",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/userInvitations",
}
},
{
"name": "user_invitations_get_instance",
"table_name": "user_invitation_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/userInvitations/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "user_invitations_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[userInvitations]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
# "limit[visibleApps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "users_get_instance",
"table_name": "user_response",
"endpoint": {
"data_selector": "$",
"path": "/v1/users/{id}",
"params": {
"id": {
"type": "resolve",
"resource": "users_get_collection",
"field": "id",
},
# the parameters below can optionally be configured
# "fields[users]": "OPTIONAL_CONFIG",
# "include": "OPTIONAL_CONFIG",
# "fields[apps]": "OPTIONAL_CONFIG",
# "limit[visibleApps]": "OPTIONAL_CONFIG",
},
}
},
{
"name": "users_visible_apps_get_to_many_relationship",
"table_name": "visible_app",
"primary_key": "id",
"write_disposition": "merge",
"endpoint": {
"data_selector": "data",
"path": "/v1/users/{id}/relationships/visibleApps",
"params": {
"id": {
"type": "resolve",
"resource": "users_get_collection",
"field": "id",
},
},
}
},
]
}
return rest_api_source(source_config)
2. Configuring your source and destination credentials
info
dlt-init-openapi will try to detect which authentication mechanism (if any) is used by the API in question and add a placeholder in your secrets.toml.
The dlt cli will have created a .dlt directory in your project folder. This directory contains a config.toml file and a secrets.toml file that you can use to configure your pipeline. The automatically created version of these files look like this:
generated config.toml
[runtime]
log_level="INFO"
[sources.apple_app_store_connect]
# Base URL for the API
base_url = "https://api.appstoreconnect.apple.com/"
generated secrets.toml
[sources.apple_app_store_connect]
# secrets for your apple_app_store_connect source
token = "FILL ME OUT" # TODO: fill in your credentials
2.1. Adjust the generated code to your usecase
Further help setting up your source and destinations
At this time, the dlt-init-openapi cli tool will always create pipelines that load to a local duckdb instance. Switching to a different destination is trivial, all you need to do is change the destination parameter in apple_app_store_connect_pipeline.py to postgres and supply the credentials as outlined in the destination doc linked below.