Add Competitors
add_competitorsTrack one or more rival apps against one of YOUR apps. Each competitor can be given as an Apptail app_id, an App Store URL, or just a name — names and URLs are resolved and imported the way search_apps does, so you do NOT need to look up an app_id first. Returns one outcome per item: what was added, what was already tracked, and what a plan limit refused.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app_id | Yes | Apptail app id for one of YOUR apps — from get_account. The rivals are tracked FOR this app: competitor sets belong to an app, not to the account, so removing one later affects only this app. | |
| country | No | Storefront to resolve names in, ISO 3166-1 alpha-2 (e.g. US, DE). Omit and it is guessed from the script the name is written in. Ignored for items given as an app_id. | |
| dry_run | No | Resolve every item and report what would happen, without tracking anything. Use it when the user named apps ambiguously and you want to confirm you found the right ones before changing their account. | |
| competitors | Yes | The rivals, up to 20. Each item is an Apptail app_id, a full App Store URL, or an app name in any language. Send all of them in one call — the plan limit is checked per item, so a batch that runs out of room still adds what fits and says which items did not. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app_id | Yes | The app these rivals are tracked against. | |
| dry_run | Yes | True when nothing was written. Every outcome then reads `would_add`. | |
| outcomes | Yes | One row per item, in the order they were sent. Read `status` per row: a batch is rarely all one thing, and reporting it as "done" when two of five were refused is the failure this shape exists to prevent. | |
| remaining | No | Competitor slots left for this app on this plan after the call. Null when the plan is unlimited. Zero means the next add will be refused — say so rather than letting the user find out. | |
| added_count | Yes | How many are now tracked that were not before. | |
| requested_count | Yes | How many items were sent. |