Sign in

v1

latestOpenAPI 3.1.02026-07-24450694.7 KB

App Store Connect by In-App Event

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

get/accounts/ios/reports/in_app_events

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' | 'iap' | 'sales' | 'paying-users' | 'sessions' | 'active-devices' | 'rolling-active-devices' | 'event-impressions-unique' | 'event-notification-taps' | 'event-opens' | 'event-page-views-unique' | 'event-reminders' 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.

in_app_eventsstring required

The comma separated list of in-app event ids.

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

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": {
    "545519333": {
      "us": {
        "6443741640": {
          "start_date": "2024-01-24",
          "end_date": "2024-02-07",
          "values": [
            200
          ]
        },
        "6444430656": {
          "start_date": "2024-01-24",
          "end_date": "2024-02-07"
        }
      }
    }
  },
  "metadata": {
    "request": {
      "path": "/api/public/integrations/accounts/ios/reports/in_app_events",
      "params": {
        "start_date": "2024-01-24",
        "end_date": "2024-02-07",
        "id": "aaa00bbb-0bba-ccdd-eeff-1234567890ab",
        "in_app_events": [
          "6443741640"
        ],
        "property": "event-impressions-unique",
        "apps": [
          "545519333"
        ],
        "countries": [
          "us"
        ]
      },
      "cost": 1,
      "max_credit_cost": 1,
      "status": 200
    }
  }
}