AppFollow API: Description, Methods & Examples

Updated 4 days ago by Evgeny Kruglov

API from AppFollow helps you reply to reviews, follow keywords changes and ranking, and track apps' updates no matter what tools you use. The API has the ready-made methods to quickly access all data. Wherever you are, you have everything you need to grow your mobile app and get more customers.

Settings

Documentation: https://watch.appfollow.io/api

API Base URL: https://api.appfollow.io

Messages' format: JSON

Requests’ format: GET/POST

Instruction on how to access data using POSTMAN is below.

Access to AppFollow API

1. Go to your personal account settings and get:

  • cid — client’s ID
  • api_secret — client’s secret key

2. Choose an API method, create a request (optional: add additional parameters).

3. Add a signature to your request after "sign" parameter.

You already have all signatures you may need in your account. Use them or create your own (instructions below).

4. You’re done now!

How to create a signature

Signature consists of 3 parts:

  • Parameters (Name=Value): required and additional;

Note: sort parameters by Name (A-Z);

Example: apps_id=, cid=, date_from= etc.;

  • API method (URI path).

Example: /ratings;

  • api_secret.

Signature examples:

sign = md5(cid=124ext_id=903655975/ratingsYOUR_API_SECRET)

sign = md5(apps_id=1111cid=124/ratingsYOUR_API_SECRET)

Request example:

https://api.appfollow.io/ratings?cid=966&ext_id=618783545&sign=2dd47bc7a0328cf61ace906f433c3541

SDK

Methods

Here we gathered all ready-to-use methods you may need:

  1. App Collections List 
  2. Apps of the Collection 
  3. Reviews 
  4. Reviews Summary
  5. Review Reply (required to reply to reviews)
  6. Review Tags Update
  7. Review Bug Trackers Update
  8. Review Notes Update
  9. Ratings
  10. Versions (any changes, including metadata)
  11. What's New (new versions)
  12. Rankings
  13. Keywords
  14. Keywords Edit
  15. ASO Suggest
  16. ASO Search
  17. ASO Search Ads
  18. ASO Trending
  19. App Analytics
  20. ASO Reports
  21. Stat Reviews
  22. Stat Reviews Rating
  23. Stat Reviews by Version
  24. Stat Reviews Replies
  25. Stat Replies Speed
  26. Collection Reviews
  27. Review Custom Status (private beta)
  28. Ratings Export
  29. Featured Reviews
  30. Replies Statistics
  31. Countries
  32. ASO Reports Countries
  33. Featured Apps (for App Store)
  34. Public Top Charts

In the Documentation we've included request examples, you just need to copy them.

You will also find the response examples:

More documentation here.

Handling Errors

In case there are any errors, server answer would be in JSON format, status 200 (except mistakes 502 и 504).

Error example: https://api.appfollow.io/sdsd

Postman

You can download pre-configured postman collection and import it to Postman. Or you can configure collection on your own:

  1. Create Postman collection or open collection settings in already created Postman collection:
  1. Open Pre-request Scripts tab and paste this script there:
    var sdk = require('postman-collection');
    CID = pm.variables.get("CID");
    SECRET_KEY = pm.variables.get("SECRET_KEY");
    var query = {};
    pm.request.url.query.all().each(function(param){
    if(!param.disabled) {
    query[param.key] = param.value;
    }
    });
    query.cid = CID;
    delete query.sign;
    const sorted = {};
    const arrayKeys = [];
    Object.keys(query).forEach(key => {
    if (Object.prototype.hasOwnProperty.call(query, key)) {
    arrayKeys.push(key);
    }
    });
    arrayKeys.sort();
    arrayKeys.forEach(key => {
    sorted[key] = query[key];
    });
    let signString = '';
    Object.keys(sorted).forEach(attr => {
    signString += `${attr}=${sorted[attr]}`;
    });
    url = new sdk.Url(request.url);
    url.path.forEach(part => {
    signString += `/${part}`;
    });
    signString += SECRET_KEY;
    sign = CryptoJS.MD5(signString).toString();
    pm.variables.set("sign", sign)
  1. Open Variables tab and add SECRET_KEY and CID variables. You can get them in your account settings (api_secret; cid).
  1. Create Postman request. Example of configuration:
  1. Click Send to process the request and receive response from the server:
  1. Configure all needed endpoints in the way you did before. cid and sign parameters of request should be exactly like in the previous Postman request configuration otherwise pre-request script will fail to generate signature for request. Therefore you request will be rejected by server.
Access to AppFollow API is available for Free and Premium plans. 

Need help? Just hit the red Intercom button - we're here to help.


How did we do?