You can use Adikteev Churn API to pull a list of your app users ranked by churn probability and leverage our machine learning capabilities for diverse marketing purposes. Feel free to reach out to your Adikteev client partner to know more about the possible use cases.

Prerequisites

Data stream

To start the churn prediction model, we will require access to your organic app events. You can refer to this documentation to activate this data stream from your MMP.

Once this step is completed, we will need a minimum of 7 days of data history to have a first churn-based segmentation of your user base. Churn predictions are recomputed daily and they reach their highest accuracy after 3 months or more of data history.

API credentials

First, ask your Adikteev Account Manager to provide you client credentials to access our Churn API. You will need to provide a valid email address, and you will receive a confidential password in return.

Using the Churn API

Authenticate to the API

Churn API uses OAUTH2 protocol for authentication. To get your API access token, you must make a POST request to the token delivery endpoint:

Route

https://public-api.adikteev.com/token

Mandatory Header

authorization: Basic cmVwb3J0aW5nX2Rhc2hib2FyZDo=

Request Body

Email and password must be replaced with your actual credentials from the previous step

username={your_email}&password={your_password}&grant_type=password

If your email and password are recognized, you will receive a JSON response containing a token valid for 30 days.

curl \
-H 'authorization: Basic cmVwb3J0aW5nX2Rhc2hib2FyZDo=' \
--data 'username=hello@adikteev.com&password=mypassword&grant_type=password' \
-X POST 'https://public-api.adikteev.com/token'

Sample Response

{
 "access_token": "123456789",
 "token_type: "bearer", 
 "expires_in: 2592000
}

Pull churn prediction data

https://public-api.adikteev.com/churn_scores

Mandatory query parameters: 

• bundle: app bundle identifier, in the format "com.domain.appname". Beware for iOS apps this is not the numerical store ID.
• os: "ios" or "android"

Optional query parameters:

• date: "YYYY-MM-DD" (or just "latest")

⚠️ Past churn segments are stored for 90 days, after that they are deleted and not accessible anymore.

API output

Each valid call to Adikteev Churn API will return a CSV file with the two following columns:

• IDFV for iOS apps or GAID for Android apps
• Churn bucket: Integer from 1 to 10 representing the predicted probability to have churned (lowest probability being 1 and highest probability being 10)

Sample output

idfv,churn_bucket
00000C78-A0CB-4C31-865B-F7633F92C64D,1
87F9D23D-8886-4262-B4C9-BBCC68F94262,1
1A720ABF-38A3-4807-A774-99F3E018B710,3
87F9C6E6-E25B-4F98-821C-B89F3B3BF02F,8
87F9BD65-21B9-4AEF-87F1-6AF141B72940,1
87F8FA1A-FB2D-4633-899B-23EE574C9817,10

Examples using curl

- without date will return the latest available churn segments:

curl -L --output "myscores.csv" --H 'authorization: Bearer 123456789' \ 
  'https://public-api.adikteev.com/churn_scores?bundle=some_bundle&os=some_os'

curl -L --output "myscores.csv" --H 'authorization: Bearer 123456789' \ 
  'https://public-api.adikteev.com/churn_scores?bundle=some_bundle&os=some_os&date=latest'

curl -L --output "myscores.csv" --H 'authorization: Bearer 123456789' \ 
  'https://public-api.adikteev.com/churn_scores?bundle=some_bundle&os=some_os&date=YYYY-MM-DD'