Workflows · From Tasks · from_apple_app_store_connect

Purpose

Configuration

Example usage

task:
    type: from_apple_app_store_connect
    start_date: yesterday -1 day
    end_date: yesterday -1 day

extract:
    type: /v1/salesReports
    params:
        filter[frequency]: DAILY
        filter[reportDate]: "{{ task.start_date.strftime('%Y-%m-%d') }}"
        filter[reportSubType]: SUMMARY
        filter[reportType]: SALES
        filter[vendorNumber]: 12345678

deduplicate:
    type: date_range
    field: begin_date

Properties

property	type	required	description
`type`	enumerator (see description)	yes	Contains the report you want to download. Must be one of: `/v1/salesReports`
`filter[frequency]`	enumerator (DAILY, WEEKLY, MONTHLY, YEARLY)	yes	Frequency of the report to download. For a list of values, see Allowed Values Based on Sales Report Type.
`filter[reportDate]`	date (YYYY-MM-DD)	yes	The report date to download. Specify the date in the YYYY-MM-DD format for all report frequencies except DAILY, which doesn’t require a date. For more information, see report availability and storage.
`filter[reportSubType]`	enumerator (SUMMARY, DETAILED)	yes	The report sub type to download. For a list of values, see Allowed Values Based on Sales Report Type below.
`filter[reportType]`	enumerator (SALES, PRE_ORDER, NEWSSTAND, SUBSCRIPTION, SUBSCRIPTION_EVENT, SUBSCRIBER, SUBSCRIPTION_OFFER_CODE_REDEMPTION)	yes	The report to download. For more details on each report type see About Reports.
`filter[vendorNumber]`	enumerator (SALES, PRE_ORDER, NEWSSTAND, SUBSCRIPTION, SUBSCRIPTION_EVENT, SUBSCRIBER, SUBSCRIPTION_OFFER_CODE_REDEMPTION)	yes	You can find your vendor number in View payments and proceeds.
`filter[version]`	string	no	The version of the report. For a list of values, see Allowed Values Based on Sales Report Type.
`conn_id`	string	no	Connection string as handed to you by the Onesecondbefore team. Default is `apple_app_store_connect`

Details

item	description
`API`	Apple App Store Connect API
`Pre-formatted schema`	Yes. Comes with a pre-formatted and described schema.