Get Competitors
get_competitorsList tracked competitor apps for one of your apps, with how many more the plan allows — and suggested: up to ten rivals the account does not track yet, ranked by how many of the app's own search terms they sit in the top ten for. Works on an app with no keywords: its listing is read for terms and the store is crawled for them. Read suggested_basis.terms_pending before calling a short list complete. Suggestions can persist shared keyword records and queue background crawls. Suggested apps are not added to your competitor watchlist.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app_id | Yes | Apptail app id for one of YOUR apps — get it from get_account. Not the numeric id in an App Store URL (that is apple_app_id). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Number of competitors returned. | |
| limit | Yes | How many competitors this plan allows per app. -1 means unlimited. | |
| app_id | Yes | The app these rivals are tracked against. | |
| remaining | No | Slots left before add_competitors is refused. Null when the plan is unlimited. | |
| suggested | Yes | Rivals worth tracking that are not on the list, strongest evidence first: apps in the top ten of the terms this app competes on (tracked, already ranked for, or read off its listing when it has neither), never the account's own apps, never one already tracked, never one hidden from the Landscape. Offer them with their `sample_terms`; add with add_competitors only when asked. Empty when the app has nothing to derive from — say that rather than "no competitors exist". | |
| competitors | Yes | Apps tracked as competitors of the given app. Empty if none are tracked yet. | |
| suggested_basis | No | What the suggestions were derived from. Null when the app is not one of the account's own — a suggestion needs your terms to read. |