---
canonical_url: "https://docs.composio.dev/toolkits/appfollow"
markdown_url: "https://docs.composio.dev/toolkits/appfollow.md"
product: "platform"
version: null
last_updated: null
---

# AppFollow

AppFollow helps teams monitor app-store performance, analyze ratings and reviews, research keywords, and manage review workflows.

- **Category:** reviews
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 43
- **Triggers:** 0
- **Slug:** `APPFOLLOW`
- **Version:** 00000000_00

## Tools

### Add App

**Slug:** `APPFOLLOW_ADD_APP`

Add an existing store app to an AppFollow collection. This changes collection membership and requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `store` | string | Yes | Store code for the app. |
| `locale` | string | Yes | Country code used when adding the app. |
| `user_id` | integer | No | Optional AppFollow user ID associated with the operation. |
| `store_app_id` | string | Yes | Store app identifier: the Android package name or numeric iOS App Store ID, as applicable. |
| `collection_id` | integer | Yes | ID of the destination AppFollow collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Collection

**Slug:** `APPFOLLOW_ADD_COLLECTION`

Create an AppFollow app collection with required country codes and optional default-country and report-schedule settings. Requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Report recipient email. Required when any report schedule is set. |
| `ranks` | string | No | Comma-separated rank report schedules. |
| `title` | string | Yes | Title for the new collection. |
| `reviews` | string | No | Comma-separated review report schedules. |
| `keywords` | string | No | Comma-separated keyword report schedules. |
| `countries` | string | Yes | Comma-separated country codes included in the collection. |
| `dashboard` | string | No | Comma-separated dashboard report schedules. |
| `app_updates` | string | No | Comma-separated timeline report schedules. |
| `default_country` | string | No | Default country code for the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add User

**Slug:** `APPFOLLOW_ADD_USER`

Create an AppFollow account user with a role and optional collection access. This grants account access and requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Display name for the new user. |
| `role` | string | Yes | AppFollow role assigned to the user. |
| `email` | string | Yes | Email address for the new user. |
| `collections` | string | No | Comma-separated collection IDs the user may access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get App Featured History

**Slug:** `APPFOLLOW_GET_APP_FEATURED_HISTORY`

Get App Store featuring history for an app, optionally filtered by country, feature type, and date range. Costs 12 credits per request, plus 12 credits per additional 14 days beyond the first 14 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Optional country code. |
| `feature` | string | No | Optional feature type. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Numeric iOS App Store ID for the app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get App Rankings

**Slug:** `APPFOLLOW_GET_APP_RANKINGS`

Get store ranking records for an app, optionally filtered by country, device, genre, and date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Optional ranking date in YYYY-MM-DD format. |
| `device` | string | No | Optional device name. |
| `country` | string | No | Optional country code. |
| `genre_id` | string | No | Optional store genre ID. |
| `store_app_id` | string | Yes | Store app identifier: the Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ASO Keyword Suggestions

**Slug:** `APPFOLLOW_GET_ASO_KEYWORD_SUGGESTIONS`

Return App Store Optimization keyword suggestions for a search term, optionally localized by country and device.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `term` | string | Yes | Keyword or phrase to research. |
| `device` | string | No | Optional store device code. |
| `country` | string | No | Optional country code for localized suggestions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ASO Report

**Slug:** `APPFOLLOW_GET_ASO_REPORT`

Get app download ASO metrics by channel or as a time series, optionally filtered by country, date range, and period. Requires the Team plan and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string ("daily" | "weekly" | "monthly") | No | Aggregation period appropriate for the selected date range. |
| `channel` | string ("channel" | "time_series") | No | Use 'channel' for a source breakdown or 'time_series' for totals over time. |
| `country` | string | No | Optional country code. |
| `to_date` | string | No | Optional report end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional report start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Store app identifier: the Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Featured Reviews

**Slug:** `APPFOLLOW_GET_FEATURED_REVIEWS`

Get featured-review history for an app, optionally filtered by country, language, custom statuses, and date range. Requires an Enterprise plan and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Optional language code. |
| `country` | string | No | Optional country code. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Store app identifier: the Android package name or numeric iOS App Store ID, as applicable. |
| `custom_status` | string | No | Comma-separated custom review statuses to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Google Developer Console Acquisition Report

**Slug:** `APPFOLLOW_GET_GOOGLE_DEVELOPER_CONSOLE_ACQUISITION_REPORT`

Get a Google Developer Console acquisition report by channel for one Android app and date range. Requires the Team plan and a configured integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("all" | "search" | "explore" | "3rdparty") | Yes | Acquisition channel included in the report. |
| `country` | string | No | Optional country code. |
| `to_date` | string | Yes | End date in YYYY-MM-DD format. |
| `from_date` | string | Yes | Start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name for the app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Google Play Console Metric History

**Slug:** `APPFOLLOW_GET_GOOGLE_PLAY_CONSOLE_METRIC_HISTORY`

Get Google Play Console ratings or user-count history for an app in a collection. Requires an Enterprise feature or integration and may return access denied when it is not enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | Yes | Single metric to return: ratings or users; AppFollow does not allow both together. |
| `period` | string ("daily" | "weekly" | "monthly" | "quarter") | No | Aggregation period. |
| `country` | string | No | Optional two-letter country code. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name. |
| `collection_name` | string | Yes | Name of the AppFollow collection containing the app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Public Top Charts

**Slug:** `APPFOLLOW_GET_PUBLIC_TOP_CHARTS`

Get a public app-store top chart for a country, device, genre, and date. Costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Chart date in YYYY-MM-DD format. |
| `genre` | string | Yes | Store genre ID. |
| `device` | string | Yes | Store device name. |
| `country` | string | Yes | Country code for the chart. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ratings History

**Slug:** `APPFOLLOW_GET_RATINGS_HISTORY`

Get one page of app rating history with store, collection, country, period, version, and calculation filters. Requires a Team feature, costs 12 credits per request, and may return access denied when not enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("diff" | "total") | No | Rating calculation: incremental differences or total values. |
| `limit` | integer | No | Maximum records to return on this page. |
| `store` | string ("as" | "gp" | "ms" | "am" | "mc" | "xs") | Yes | Store where the app is published. |
| `offset` | integer | No | Starting offset for data retrieval. |
| `period` | string ("daily" | "weekly" | "monthly" | "quarter") | No | Aggregation period. |
| `country` | string | No | Deprecated single two-letter country filter. The countries array takes priority when both are provided. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `version` | string | No | Optional app version filter. |
| `countries` | array | No | Two-letter country codes. 'all' is supported for App Store and Google Play only when type is total. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |
| `collection_name` | string | Yes | Name of the AppFollow collection containing the app. |
| `include_negative_changes` | boolean | No | Whether to include negative rating changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reply Counts

**Slug:** `APPFOLLOW_GET_REPLY_COUNTS`

Get review reply-count statistics for an app, optionally filtered by API user login and date range. Requires an Enterprise plan and costs 12 credits per request, plus 12 credits per additional 14 days beyond the first 14 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login` | string | No | Optional API user login filter. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reply Speed Statistics

**Slug:** `APPFOLLOW_GET_REPLY_SPEED_STATS`

Get review reply-time distribution statistics for an app, optionally filtered by replying user and date. Requires an Enterprise plan and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Optional review date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |
| `answer_user_id` | string | No | Optional replying user ID filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Review Rating Statistics

**Slug:** `APPFOLLOW_GET_REVIEW_RATING_STATS`

Get review rating statistics for an app, optionally filtered by review date and replying user. Requires the Team plan and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Optional review date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |
| `answer_user_id` | string | No | Optional replying user ID filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Review Reply Statistics

**Slug:** `APPFOLLOW_GET_REVIEW_REPLY_STATS`

Get review reply, note, and tag activity statistics for an app, optionally filtered by replying user, date, or date range. Requires an Enterprise plan and costs 12 credits per request, plus 12 credits per additional 14 days beyond the first 14 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Optional review date in YYYY-MM-DD format. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |
| `answer_user_id` | string | No | Optional replying user ID filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reviews AI Summary

**Slug:** `APPFOLLOW_GET_REVIEWS_AI_SUMMARY`

Generate an AI summary of reviews for an app, collection, store, date range, and optional countries. Costs 48 credits per request and may require the Team plan feature to be enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `store` | string ("as" | "gp" | "ms" | "am" | "mc" | "xs") | Yes | Store where the app is published. |
| `to_date` | string | Yes | End date in YYYY-MM-DD format. |
| `countries` | array | No | Optional country codes included in the summary. |
| `from_date` | string | Yes | Start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |
| `collection_name` | string | Yes | Name of the AppFollow collection containing the app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Review Semantic Tags

**Slug:** `APPFOLLOW_GET_REVIEW_SEMANTIC_TAGS`

Get semantic review tags and analysis for an app, optionally filtered by language, rating, sentiment, tag, version, and date range. Costs 48 credits per request and requires the Enterprise Semantic Tags feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Optional semantic tag name filter. |
| `lang` | string | No | Optional language code. |
| `rating` | integer | No | Optional star-rating filter from 1 to 5. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `version` | string | No | Optional app version filter. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `sentiment` | string | No | Optional sentiment type filter. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reviews Summary

**Slug:** `APPFOLLOW_GET_REVIEWS_SUMMARY`

Get aggregate review and rating counts and averages for an app, optionally filtered by country, language, version, and date range. Costs 12 credits per request, plus 12 credits per additional 14 days beyond the first 14 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Optional language code. |
| `country` | string | No | Optional country code. |
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `version` | string | No | Optional app version. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Review Statistics

**Slug:** `APPFOLLOW_GET_REVIEW_STATS`

Get aggregate review and reply statistics for an app and optional date range. Requires the Team plan and costs 12 credits per request, plus 12 credits per additional 14 days beyond the first 14 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | Optional end date in YYYY-MM-DD format. |
| `from_date` | string | No | Optional start date in YYYY-MM-DD format. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Review Statistics by Version

**Slug:** `APPFOLLOW_GET_REVIEW_STATS_BY_VERSION`

Get review statistics grouped by app version, with optional country, language, and date filters. Providing version narrows the result to that version. Requires the Team plan and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Optional review date in YYYY-MM-DD format. |
| `lang` | string | No | Optional language code. |
| `country` | string | No | Optional country code. |
| `version` | string | No | Optional app version filter. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Search Ads Keyword Recommendations

**Slug:** `APPFOLLOW_GET_SEARCH_ADS_KEYWORD_RECOMMENDATIONS`

Return Apple Search Ads keyword recommendations for an app name, optionally localized by country or constrained by a phrase. Requires the Team plan and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app` | string | Yes | App name used to find Apple Search Ads keyword recommendations. |
| `phrase` | string | No | Optional phrase used to narrow the keyword recommendations. |
| `country` | string | No | Optional country code for localized recommendations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Search Ads Report

**Slug:** `APPFOLLOW_GET_SEARCH_ADS_REPORT`

Get an App Store Search Ads ASO report for one app and date range. Requires the Team plan and a configured integration, and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Country code, or 'all' when supported. |
| `to_date` | string | Yes | End date for the report in YYYY-MM-DD format. |
| `from_date` | string | Yes | Start date for the report in YYYY-MM-DD format. |
| `report_type` | string | No | Country-breakdown report type used when country is 'all'. |
| `store_app_id` | string | Yes | Numeric iOS App Store ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List App Collections

**Slug:** `APPFOLLOW_LIST_APP_COLLECTIONS`

List AppFollow app collections available to the connected API token, including collection IDs needed by other actions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List App Versions

**Slug:** `APPFOLLOW_LIST_APP_VERSIONS`

List one page of app versions and metadata changes for an app and country, optionally filtered by language and uniqueness. Costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Optional language code used to select the app-store listing. |
| `page` | integer | No | Initial provider page number. Use next_cursor for continuation. |
| `unique` | integer ("0" | "1") | No | Set to 1 for unique app versions or 0 for all metadata changes. |
| `country` | string | Yes | Country code used to select the app-store listing. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List App What's New Entries

**Slug:** `APPFOLLOW_LIST_APP_WHATS_NEW`

List one page of app release-note changes, optionally filtered by country, language, and last-modified time. Costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Optional language code. |
| `page` | integer | No | Initial provider page number. Use next_cursor for continuation. |
| `country` | string | No | Optional country code. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |
| `last_modified` | string | No | Optional last-modified cutoff in YYYY-MM-DD HH:MM:SS format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collection Apps

**Slug:** `APPFOLLOW_LIST_COLLECTION_APPS`

List apps in one AppFollow collection and return app identifiers needed by analytics and review actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | integer | Yes | AppFollow collection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tracked Keywords

**Slug:** `APPFOLLOW_LIST_KEYWORDS`

List one page of tracked ASO keywords and ranking data for an app. Requires the Team plan and costs 12 credits per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Data date in YYYY-MM-DD format; defaults upstream to today. |
| `page` | integer | No | Initial provider page number. Use next_cursor for continuation. |
| `device` | string | No | Optional store device name. |
| `country` | string | No | Optional two-letter country code. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |
| `store_app_id` | string | Yes | Android package name or numeric iOS App Store ID, as applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Reviews

**Slug:** `APPFOLLOW_LIST_REVIEWS`

List one page of reviews for either a store app ID or a collection name over a required date range, with optional review filters. Costs 12 credits per request; free plans are limited to the latest 50 reviews.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Optional language code filter. |
| `page` | integer | No | Initial provider page number. Use next_cursor for continuation. |
| `query` | string | No | Optional text to search for in review content. |
| `country` | string | No | Optional country code filter. |
| `to_date` | string | Yes | End date in YYYY-MM-DD format. |
| `from_date` | string | Yes | Start date in YYYY-MM-DD format. |
| `review_id` | string | No | Optional store review ID filter. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |
| `store_app_id` | string | No | Android package name or numeric iOS App Store ID, as applicable. Provide this or collection_name. |
| `custom_status` | string | No | Comma-separated custom review statuses to include. Requires the AppFollow Review Status feature. |
| `last_modified` | string | No | Optional review last-modified cutoff in YYYY-MM-DD HH:MM:SS format. |
| `collection_name` | string | No | AppFollow collection name. Provide this or store_app_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `APPFOLLOW_LIST_USERS`

List AppFollow account users, optionally filtering by user ID or email. Requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Optional user ID filter. |
| `email` | string | No | Optional user email filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove App

**Slug:** `APPFOLLOW_REMOVE_APP`

WARNING: Permanently remove an app from an AppFollow collection. This destructive operation may remove associated collection tracking and requires an Enterprise full-access token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `store` | string | Yes | Store code for the app to remove. |
| `user_id` | integer | No | Optional AppFollow user ID associated with the operation. |
| `store_app_id` | string | Yes | Store app identifier to remove: Android package name or numeric iOS identifier. |
| `collection_id` | integer | Yes | Collection ID from which to remove the app. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Collection

**Slug:** `APPFOLLOW_REMOVE_COLLECTION`

Permanently remove an AppFollow collection and its tracked configuration. This destructive operation requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | integer | Yes | ID of the AppFollow collection to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove User

**Slug:** `APPFOLLOW_REMOVE_USER`

Permanently remove an AppFollow account user by ID, optionally matching their email. This destructive action revokes the user's account access, cannot be undone, and requires an Enterprise full-access token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of the user to permanently remove. |
| `email` | string | No | Optional email filter for the user being removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reply to Review

**Slug:** `APPFOLLOW_REPLY_TO_REVIEW`

Publish an externally visible reply to a store review, optionally attributed to an API user login. This mutation may be irreversible and requires the Team plan and a reply integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `login` | string | No | Private-beta API user login used for statistics and display. |
| `review_id` | string | Yes | Store review ID to reply to. |
| `answer_text` | string | Yes | Reply text that will be published to the store review. |
| `store_app_id` | string | Yes | Store app identifier: Android package name or numeric iOS identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Report Review Concern

**Slug:** `APPFOLLOW_REPORT_REVIEW_CONCERN`

Submit a concern about a store review. This sends an external moderation report that is irreversible and cannot be recalled; it requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `store` | string | Yes | Store identifier in the long format required by AppFollow. |
| `review_id` | string | Yes | Store review ID to report. |
| `concern_type` | string | Yes | Provider-supported concern type. |
| `store_app_id` | string | Yes | Store app identifier: Android package name or numeric iOS identifier. |
| `concern_explanation` | string | Yes | Explanation submitted with the concern. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Apps

**Slug:** `APPFOLLOW_SEARCH_APPS`

Search app stores for apps matching a keyword, optionally filtered by country and device.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `term` | string | Yes | Keyword used to search for apps. |
| `device` | string | No | Optional store device code. |
| `country` | string | No | Optional country code used to localize store results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Review Bug Tracker Tags

**Slug:** `APPFOLLOW_UPDATE_REVIEW_BUG_TRACKER_TAGS`

Replace bug-tracker tag names on a review, optionally within a collection. This changes review metadata and requires the corresponding integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | string | Yes | Comma-separated bug-tracker tag names, including required integration prefixes such as OTRS. |
| `review_id` | string | Yes | Review ID to update. |
| `store_app_id` | string | Yes | Store app identifier: Android package name or numeric iOS identifier. |
| `collection_id` | integer | No | Optional AppFollow collection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Review Note

**Slug:** `APPFOLLOW_UPDATE_REVIEW_NOTE`

Set the internal note content on a review. This changes review metadata and requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | New internal note text. |
| `review_id` | string | Yes | Review ID to update. |
| `store_app_id` | string | Yes | Store app identifier: Android package name or numeric iOS identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Review Status

**Slug:** `APPFOLLOW_UPDATE_REVIEW_STATUS`

Set a review's private-beta custom status to reopened or closed. This changes review workflow state and requires the Enterprise Review Status feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `review_id` | string | Yes | Review ID to update. |
| `store_app_id` | string | Yes | AppFollow store app ID. |
| `custom_status` | string ("reopened" | "closed") | Yes | New custom review status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Review Tags

**Slug:** `APPFOLLOW_UPDATE_REVIEW_TAGS`

Replace tag names on a review, optionally within a collection. This changes review metadata and requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | string | Yes | Comma-separated tag names to set. |
| `review_id` | string | Yes | Review ID to update. |
| `store_app_id` | string | Yes | AppFollow store app ID. |
| `collection_id` | integer | No | AppFollow collection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tracked Keywords

**Slug:** `APPFOLLOW_UPDATE_TRACKED_KEYWORDS`

Set the tracked keyword list for a country and device, optionally choosing a collection. This changes keyword tracking and requires the Team plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `device` | string | Yes | Device name for keyword tracking. |
| `country` | string | Yes | Country code for keyword tracking. |
| `keywords` | string | Yes | Comma-separated keywords to set. |
| `collection_id` | integer | No | Collection ID. AppFollow uses the first collection when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `APPFOLLOW_UPDATE_USER`

Replace an AppFollow user's name, role, email, and optional collection access. This changes account permissions and requires an Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | ID of the user to update. |
| `name` | string | Yes | User's complete new display name. |
| `role` | string | Yes | User's complete new AppFollow role. |
| `email` | string | Yes | User's complete new email address. |
| `collections` | string | No | Comma-separated collection IDs available to the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Reviews in Bulk

**Slug:** `APPFOLLOW_UPLOAD_REVIEWS_BULK`

Upload a batch of custom-source reviews using a client idempotency key. Items are processed independently, so partial success is possible. Depending on on_conflict, each review can be created, updated, skipped, or fail; inspect every per-review outcome.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reviews` | array | Yes | Reviews to upload with their external identities and source metadata. |
| `on_conflict` | string ("upsert" | "ignore" | "error") | No | How to handle an existing ext_review_id: update it, skip it, or abort the duplicate. |
| `idempotency_key` | string | Yes | Client-supplied idempotency key unique to this batch operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
