Sign in

v1

latestOpenAPI 3.1.02026-07-24450694.7 KB

App Store Connect by Device

The integrations reports endpoints allow you to fetch different reports related to your integrations in AppTweak with a breakdown by device.

get/accounts/ios/reports/devices

Query parameters

idstring required

The api-account-id of the integrated account. <br/> 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.

property'units' | 'redownloads' | 'total-downloads' | 'impressions-total-unique' | 'page-view-unique' | 'iap' | 'sales' | 'paying-users' | 'sessions' | 'active-devices' | 'rolling-active-devices' required

The property you want to obtain a report for. <br/> Choose from: units, installs, redownloads, etc. <br/> Get the list of properties in the <a href="https://developers.apptweak.com/reference/app-store-connect#property-parameters" target="_blank"><b>property parameter table</b></a>. You can only pass 1 property.

devicesstring

The list of devices (iphone, ipad, other) OR all which returns all devices <br/><b>Default:</b> all

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 available apps

countriesstring

The list of two letter country codes (ISO Alpha-2) separated by commas. <br/><b>Default:</b> all available countries

start_datestring

The start date for the report in the format: YYYY-MM-DD. <br/><b>Default:</b> 30 days ago

end_datestring

The end date for the report in the format: YYYY-MM-DD. <br/><b>Default:</b> yesterday

Response

200

Example response

{
  "result": {
    "1449752690": {
      "be": {
        "ipad": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            5
          ]
        },
        "iphone": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            192
          ]
        }
      },
      "fr": {
        "ipad": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            32
          ]
        },
        "iphone": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            1315
          ]
        }
      }
    },
    "1592003260": {
      "be": {
        "ipad": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            5
          ]
        },
        "iphone": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            192
          ]
        }
      },
      "fr": {
        "ipad": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            32
          ]
        },
        "iphone": {
          "start_date": "2023-01-01",
          "end_date": "2023-01-03",
          "values": [
            1315
          ]
        }
      }
    }
  },
  "metadata": {
    "request": {
      "path": "/api/public/integrations/accounts/ios/reports/devices",
      "params": {
        "start_date": "2023-01-01",
        "end_date": "2023-01-03",
        "id": "762bba71-6613-4680-a0da-c4e8de90368b",
        "devices": [
          "iphone"
        ],
        "property": "units",
        "apps": [
          "1449752690"
        ],
        "countries": [
          "be"
        ]
      },
      "cost": 1,
      "max_credit_cost": 1,
      "status": 200
    }
  }
}