At a glance
The dedicated API allows account admins to manage apps within their accounts supporting the main features available in the UI. This includes adding updating and deleting apps. The API also incorporates the same error verification mechanisms. Please note that we currently allow adding and updating mobile apps only while deletion is possible for all platforms.
Add app API parameters
Default schema
The following API parameters are needed in the schema for adding an app:
| API Parameter | Type | Mandatory | Remarks |
|---|---|---|---|
| platform | string | Yes | Possible values: android’ ios’ `windowsphone’ |
| status | string | Yes | Possible values: available’ pending’ `out_of_store’ |
| app_name | string | Yes | A string of up to 100 characters |
| currency | string | Yes | Possible values: https://docs.google.com/document/d/1W6H5WX3WZCyMYuEgHqSorU0WF6UuTQbuxF6AISxw7gc/edit#bookmark=id.eu5iuk3ovj9a |
| time_zone | string | Yes | Possible values: https://docs.google.com/document/d/1W6H5WX3WZCyMYuEgHqSorU0WF6UuTQbuxF6AISxw7gc/edit#bookmark=id.qg694lhhkeet |
Android status in the store
Additional schema parameters for the app status in Google Play and when published out of store.
| Status | API Parameter | Type | Mandatory | Remarks |
|---|---|---|---|---|
| Available in store | app_url | string | Yes | A well-formatted URL |
| Pending approval/not published | app_id | string | Yes | Link to app id required semantics per platform |
| Published out of store | app_id | string | Yes | Link to app id required semantics per platform |
| app_url | string | No | A well-formatted URL | |
| channel_name | string | Yes | a string that consists only of one or more uppercase or lowercase letters |
iOS status in the App Store
Additional schema parameters for the app status in the store.
| Status | API Parameter | Type | Mandatory | Remarks |
|---|---|---|---|---|
| Available in store | app_url | string | Yes | A well-formatted URL |
| Pending approval/not published | country | string | Yes | Possible values: https://docs.google.com/document/d/1W6H5WX3WZCyMYuEgHqSorU0WF6UuTQbuxF6AISxw7gc/edit#bookmark=id.5mm5oap13kxj |
| app_id | string | Yes | Link to app id required semantics per platform |
Update app API parameters
The following API parameters which are part of the URL are needed in the schema for updating an app:
| API Parameter | Type | Mandatory | Remarks |
|---|---|---|---|
| appId | string | Yes | A valid AppsFlyer app ID |
| platform | string | Yes | Possible values: android’ ios’ `windowsphone’ |
The following API parameters are needed in the schema for the request body:
| API Parameter | Type | Mandatory | Remarks |
|---|---|---|---|
| enableAggregatedAdvancedPrivacy | boolean | No | Enable or disable the Aggregated Advanced Privacy iOS feature for maintaining user privacy. Possible Values: true’ (enabled) or false’ (disabled) |
| minTimeBetweenSessions | number | No | Determine the minimum time between sessions for which sessions are counted. Possible Values: Values should be rendered in seconds reflecting minutes or hours. The duration can span from 1 minute to 24 hours. Suitable values range between 60 (representing 1 minute) to 86400 (representing 24 hours). |
| reAttributionWindow | number | No | The number of days after the first install that reinstalls aren’t attributed as new installs. Possible Values: Values should be rendered in days reflecting months. The duration can span from 1 to 24 months. Suitable values range between 30 (representing 1 month) to 730 (representing 24 months). |
| enableProbabilisticViewThroughAttribution | boolean | No | Enable or disable the probabilistic View-through Attribution (VTA) feature for using probabilistic modeling to attribute conversions to ad impressions that were viewed. Possible values: ’true; (enabled) or `false’ (disabled). |
| enableSeoAppAttribution | boolean | No | Enable or disable the organic search attribution feature for attributing re-engagements to various organic search engines. Possible values: true’ (enabled) or false’ (disabled). |
| enableIpMasking | boolean | No | Enable or disable the IP Masking feature for anonymizing end-user device IP addresses in raw data reports and in postbacks sent to partners (for events per app). Possible values: true’ (enabled) or false’ (disabled). |
| enableReinstallDetection | boolean | No | For iOS only: Detect reinstalls without depending on advertising IDs. Determining whether an install was a reinstall or a new install enables deduplicating reinstalls from your NOIs. Possible values: true’ (enabled) or false’ (disabled). |
| reEngagementAttribution | object | No | This property configures the Retargeting Attribution feature. When enabled (reEngagementAttribution.isEnabled is set as true) AppsFlyer tracks and attributes re-engagement events to the appropriate source providing valuable insights on user retention and re-engagement campaigns. |
| reEngagementAttribution.isEnabled | boolean | Yes | Enable or disable the Retargeting Attribution feature to record re-engagements of users engaging with a retargeting campaign. Possible values: true’ (enabled) or false’ (disabled). |
| reEngagementAttribution.minTimeBetweenReEngagements | number | No | Set the minimum time after a re-engagement conversion occurs so that additional re-engagement events won’t be attributed. This is used to avoid over-counting of conversions. Possible Values: Please provide this input in seconds. Valid values range from 3600 (representing 1 hour) to 2592000 (representing 30 days). |
Delete app API parameters
The following URL parameters are needed in the schema for deleting an app:
| API Parameter | Type | Mandatory | Remarks |
|---|---|---|---|
| appId | string | Yes | A valid AppsFlyer app ID |
| platform | string | Yes | Possible values: https://docs.google.com/document/d/1W6H5WX3WZCyMYuEgHqSorU0WF6UuTQbuxF6AISxw7gc/edit#bookmark=id.uredi0417lsz. |