App Store Connect

App Store Connect by Custom Product Page

Get App Store Connect performance for the Custom Product Pages (CPPs) you select, with a breakdown by app, country and CPP. The response contains all the info related to the selected property, grouped by app id, country code and CPP store id, without pagination. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Description</th><th>credits/request</th></tr></thead> <tbody> <tr><td><b>CPP object</b></td><td>Hash containing the name and status of the Custom Product Page, the start date and end date of the report, and the values of the property.</td><td>1</td></tr> </tbody> </table> <br/><br/> <b>Good to know</b> <br/><br/> • Custom Product Page reports cover 6 of the properties listed in the <a href="https://developers.apptweak.com/reference/app-store-connect#property-parameters" target="_blank"><b>property parameter table</b></a>: impressions-total, impressions-total-unique, page-view-count, page-view-unique, units and installs.<br/>• Apple delivers reporting data with up to 2 days of delay, so the last days of a report that reaches today normally come back null.<br/>• A CPP whose status is DELETED still carries the values recorded before it was deleted.<br/>• The CPP ids are the UUIDs App Store Connect assigns; <a href="https://developers.apptweak.com/reference/cpp-by-app" target="_blank"><b>CPP by App</b></a> returns a cpp_id for every Custom Product Page observed on the store.<br/>• Update frequency, available history and country availability are those of the other App Store Connect reports, on the <a href="https://developers.apptweak.com/reference/app-store-connect" target="_blank"><b>App Store Connect</b></a> page.

get/accounts/ios/reports/cpps

Request

  • Base URL
    https://public-api.apptweak.com/api/public/integrations
  • URL
    https://public-api.apptweak.com/api/public/integrations/accounts/ios/reports/cpps
  • Auth
    API key in header x-apptweak-key

Query parameters

idstring required

The api-account-id of the integrated account. Get the list of integrated accounts using the <a href="https://developers.apptweak.com/reference/account-list" target="_blank"><b>integrated accounts endpoint</b></a>. You can only pass 1 api account id. It must be an "itunes-connect" integration.

cppsstring required

The list of Custom Product Page store ids separated by commas. Each one is the UUID (36 characters) assigned by App Store Connect. You can pass several of them.

property'impressions-total' | 'impressions-total-unique' | 'page-view-count' | 'page-view-unique' | 'units' | 'installs' required

The property you want to obtain a report for. CPP reports cover 6 of the App Store Connect properties: impressions-total, impressions-total-unique, page-view-count, page-view-unique, units, installs. You can only pass 1 property. <br/><b>Example:</b> units

appsstring

The list of app ids separated by commas for which to fetch the report. Get the list of products using the <a href="https://developers.apptweak.com/reference/integration-product-list" target="_blank"><b>integrated apps endpoint</b></a>. <br/><b>Default:</b> all products

countriesstring

Comma-separated country codes among the territories App Store Connect reports. <br/><b>Default:</b> all countries available in App Store Connect

start_datestring date

The start date for the report in the format: YYYY-MM-DD. Must be sent together with end_date. <br/><b>Default:</b> 30 days ago

end_datestring date

The end date for the report in the format: YYYY-MM-DD. Must be sent together with start_date. <br/><b>Default:</b> yesterday

Response

One series per CPP, keyed by app ID, then country, then CPP UUID.

resultobject

Changes

No recorded changes to this operation across all 1 revision of this API.