v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

App User Retention

Returns the percentage of users that return to use an app within the first 1, 2, 3, 4, 5, 7, 14, or 30 days.

get/{store}/{app_id}/appretention

Path parameters

storestring required

Input either "Google" (Android) or "Apple" (iOS).

app_idstring required

Enter an app ID. E.g.: com.whatsapp How to find App IDs

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring required

Start month (format: YYYY-MM)

end_datestring required

End month (format: YYYY-MM)

countrystring required

Country filter, as a 2-letter ISO country code. To see the country filters you have access to, please refer to the Check Capabilities endpoint.

granularitystring required

Supports only monthly granularity.

formatstring

[optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.

Response

200

app_namestring
app_category_namestring

Example response

{
  "meta": {
    "request": {
      "granularity": "Monthly",
      "start_date": "2021-06",
      "end_date": "2021-12",
      "store": "Google",
      "app_id": "com.whatsapp",
      "format": "json",
      "country": "world"
    },
    "status": "Success",
    "last_updated": "2022-01-31"
  },
  "app_name": "com.whatsapp",
  "app_category_name": "COMMUNICATION",
  "app_retention": [
    {
      "date": "2021-06-01",
      "retention_days": [
        {
          "retention_day": "0",
          "retention_value": 1
        }
      ]
    }
  ],
  "category_retention": [
    {
      "date": "2021-06-01",
      "retention_days": [
        {
          "retention_day": "0",
          "retention_value": 1
        }
      ]
    }
  ]
}