API Methods' Descriptions

3. Reviews

Parameter

Format

Description

answer_date string YYYY-MM-DD
answer_text string Reply to the review
author string Author of the review
content string Text in the review
content_translated string If you have auto-translate, here you see translation of the review
country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
created string YYYY-MM-DD HH:MM:SS
custom_status string Opened, Closed
date string YYYY-MM-DD
ext_id integer App's external id*
has_answer integer Reply has an answer or not
internal_id integer Internal id generated by AppFollow
page integer Number of the pages. If it's only 1 page, 'prev' and 'next' are NULL
rating integer Review rating
review_id integer Review's id generated in the app store
store string App Store (as) or Google Play (gp)
thumbs_up_cnt integer Number of likes to the review
time string HH:MM:SS
title string Title of the review
user_id integer Inner store's id
was_changed integer 1 or 0, depending on whether the review was updated or not
tag:
tag_name string Names are set at AppFollow settings > Tags page
created string YYYY-MM-DD HH:MM:SS
reviews_history:
app_id integer AppFollow inner app id
app_version string The version of the app
author string Author of the review
content string The text of the previous review
count_symbols integer Number of symbols in the review
count_words: 2, integer Number of words in the review
country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country).
created string YYYY-MM-DD HH:MM:SS
date string YYYY-MM-DD
dt string YYYY-MM-DD HH:MM:SS Date and time when the review was written (if available)
has_answer integer 1 or 0 depending on whether there's a reply or not
id integer AppFollow inner id
is_deleted integer 1 or 0 whether the review was deleted
is_wait_publication integer Beta review
lang_detect string Link to full list of languages
parent_review_id integer The first user's review which later was updated
rating integer Current rating
rating_prev integer Previous rating
review_id integer Review's id generated in the app store
thumbs_down_cnt integer Number of dislikes to the review
thumbs_up_cnt integer Number of likes to the review
time string HH:MM:SS
title string Review's title
updated string YYYY-MM-DD HH:MM:SS
user_id integer User id collected from the store
vote integer or NULL
was_changed integer 1 or 0, depending on whether the review was updated or not

4. Reviews Summary

Parameter Format

Description

country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
ext_id integer App's external id*
from string YYYY-MM-DD
rating_cnt integer Number of ratings
rating_avg string Average number of ratings
reviews_avg string Average number of reviews
reviews_cnt integer Number of reviews
to string YYYY-MM-DD

9. Ratings

Parameter Format

Description

country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
date string YYYY-MM-DD
ext_id integer App's external id*
rating integer Average rating (both stars with text and just stars) from 1.000 To 5.000
review_rating integer Average rating in reviews (stars with text) from 1.000 To 5.000
stars_total integer Total number of stars
stars1 integer Number of ratings with 1 star or 0
stars2 integer Number of ratings with 2 stars or 0
stars3 integer Number of ratings with 3 stars or 0
stars4 integer Number of ratings with 4 stars or 0
stars5 integer Number of ratings with 5 stars or 0
store string App Store (as) or Google Play (gp)
version string Version of your app

12. Rankings

Parameter Format

Description

country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
date string YYYY-MM-DD (day Period); Oct 21 - Oct 23 (week Period); Oct 2019 (month Period)
device string 'iphone', 'ipad' or 'android'
ext_id integer App's external id*
feed_type string 'free', 'paid', 'gross'
genre_id string Genre id full list e.g. 'sport games' in App Store: 7016, in Google Play: game_sports
pos integer Position in the rankings chart (only for Top 200 apps both in App Store and Google Play)
store string App Store (as) or Google Play (gp)

13. Keywords

Parameter Format

Description

country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
date string YYYY-MM-DD
device string 'android, 'iphone' or 'ipad'
ext_id integer App's external id*
kw string Keyword
no_pos string Array of keywords that have positions lower than Top-200
page integer Number of the pages. If it's only 1 page, 'prev' and 'next' are NULL
popularity integer Popularity score of the keyword
pos integer App's position by the keyword
score integer Custom keyword score that can be set by users in AppFollow account or NULL
store string App Store (as) or Google Play (gp)
total integer Number of keywords for chosen app after applying additional parameters

19. ASO Reports

Parameter Format

Description

act_devices integer Number of active devices
channel (App Store) Summary, time_series, channel(app store search, app store browse, app referrer, web referrer; ), channel_country, campaign, site
channel (Google Play) Country_summary, channel (google search, organic browse, organic browse, third party referrers, utm channels, adwords), country_organic_summary
country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
crashes integer App crashes
created string YYYY-MM-DD HH:MM:SS
date string YYYY-MM-DD
ext_id integer App's external id*
feed_type string 'free', 'paid', 'gross'
from string YYYY-MM-DD
genre_id string Genre id full list e.g. 'sport games' in App Store: 7016, in Google Play: game_sports
iap integer In-app purchases
id integer AppFollow inner id
impressions integer The number of times, the app appeared in search
impressions_cr string Impressions conversion
impressions_uniq integer The number of unique impressions
installers integer The number of installers
pos integer Position in the rankings chart (only for Top 200 apps both in App Store and Google Play)
sales integer Revenue
sessions integer The number of sessions
store string App Store (as) or Google Play (gp)
sum_impressions integer
sum_installers
sum_visitors
sum_units integer
sum_views integer
to string YYYY-MM-DD
units integer The number of app units
updated string YYYY-MM-DD HH:MM:SS
vi_cr string App page views/search page impressions conversion
views integer The number of app page views
views_uniq integer Unique app page views
views_cr string Views conversion
weekday string In format 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'

27. Ratings export

Parameter Format

Description

country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
from /to string YYYY-MM-DD.
date string YYYY-MM-DD (day period); Oct 21 - Oct 23 (week period); Oct 2019 (month period)
diff_stars1 integer Difference between current and previous period
diff_stars2 integer Difference between current and previous period
diff_stars3 integer Difference between current and previous period
diff_stars4 integer Difference between current and previous period
diff_stars5 integer Difference between current and previous period
ext_id integer App's external id*
period string Day (by default) or week, or month
rating integer Average rating (both stars with text and just stars) from 1.000 To 5.000
review_rating integer Average rating in reviews (stars with text) from 1.000 To 5.000
stars_total integer Total number of stars
stars1 integer Number of ratings with 1 star or 0
stars2 integer Number of ratings with 2 stars or 0
stars3 integer Number of ratings with 3 stars or 0
stars4 integer Number of ratings with 4 stars or 0
stars5 integer Number of ratings with 5 stars or 0
store string App Store (itunes) or Google Play (googleplay)
title string App title
type string Diff (incremental) by default or total (cumulative)
version string Version of your app

33. Public Top Charts

Parameter Format

Description

artist_name string
country string Country code e.g. US (for App Store or Microsoft Store or Amazon apps only) or none (for Google Play apps and App Store apps released in one country). Full list.
date string YYYY-MM-DD
device string 'iphone', 'ipad' or 'android'
ext_id integer App's external id*
feed_type string 'free', 'paid', 'gross'
genre string Genre full list e.g. 'sport games' in App Store: 7016, in Google Play: game_sports
hours integer Number of hours since the data was collected
icon string Link to the icon
pos_curr integer Current position
pos_dif integer Difference between previous and current positions
pos_prev integer Previous position
price integer Price of the app or NULL
rating_avg integer Average rating of the app; 1.00 Format
rating_cnt integer The number of overall ratings
store string App Store (as) or Google Play (gp)
title string App title
url string Link to the app in the store

* App external id:

App Store — this is 9-10 digits identification number;

Google Play — this is bundle name;

Microsoft Store — this is 12 characters consisting of letters and numbers;

Amazon — this is 10 characters consisting of capital letters and numbers.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us