List of Applications with Performance Data

This endpoint returns the applications on your account that performance data can be requested for. Use it to discover the exact applicationName values the other performance endpoints expect, and which metrics each application supports.

Endpoint

Method	URL
GET	https://ws.catappult.io/api/statistics/availableApplications

Authentication

To access this API, you need to have an active account subscription on Aptoide Connect and authenticate with an API key (check here how to generate one).

⚠️

Account type required

Performance data can only be retrieved by accounts of type Developer.

Headers

Header	Type	Required	Description
Api-Key	string	Required	Used to authenticate your API requests. The value is your Aptoide Connect API key.

Query Parameters

This endpoint takes no query parameters.

Response

Success

If the API call returns an HTTP 200 status code, the request was successful and it returns a JSON array of applications. An empty array means the account has no applications with performance data.

Field	Type	Description
applicationName	string	The package name to pass as applicationName to the other performance endpoints.
applicationTitle	string	The application's display name.
applicationIconUrl	string	URL of the application icon.
operatingSystemName	string	The platform this entry refers to, android or ios. The same package name can appear once per platform.
showSalesData	boolean	Whether revenue can be requested for this application.
showInstallsData	boolean	Whether installs can be requested for this application.
showDownloadsData	boolean	Whether downloads can be requested for this application.
minFromDate	string	Earliest date performance data exists for.
maxToDate	string	Latest date performance data is available for, or null when there is no upper bound.
isCurrentOwner	boolean	Whether the account currently owns this application.
billing	object	Billing integration of the application, including hasBilling and method.

💡

The same package name can appear twice

Package names are unique per platform, not on their own, so an application published for both Android and iOS appears as two entries with the same applicationName and different operatingSystemName. Pass operatingSystem to the other performance endpoints to select between them.

Example Response

[
    {
        "applicationIconUrl": "https://cdn-catappult.aptoide.com/icon/example-icon.png",
        "applicationName": "com.example.test",
        "applicationTitle": "Example App",
        "billing": {
            "hasBilling": true,
            "method": "catappult-sdk",
            "verifiedMethod": "sdk"
        },
        "isCurrentOwner": true,
        "marketingRating": null,
        "maxToDate": null,
        "minFromDate": "2024-05-09 06:50:41",
        "operatingSystemName": "android",
        "showDownloadsData": false,
        "showIncludedMarketingValueSummary": false,
        "showInstallsData": true,
        "showSalesData": true,
        "showSalesSummary": false
    }
]

⚠️

Availability flags are not a guarantee of data

showSalesData, showInstallsData and showDownloadsData describe what the application's integration supports. An application without an approved and distributed version still returns an INVALID-TYPE error from the performance endpoints, with an empty list of allowed types, even when these flags are true.

Errors

Code	HTTP Status	Description	Resolution
—	401 Unauthorized	The API key was not recognised	Check the key, and that the account is approved
SUBSCRIPTION-REQUIRED	402 Payment Required	No active account subscription	Activate a subscription for the account
DAILY-QUOTA-REACHED	429 Too Many Requests	Daily request quota exceeded	Retry after the quota resets at midnight UTC