add-competitorfreeStored Metrics & ReportingAdd Competitor Tool
Add a competitor brand to a site after a metered initial coverage probe. Returns the full updated competitor list.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| site_id | integer | required | The tracked site id. |
| name | string | required | Competitor brand or company name. |
| x_handle | string | optional | Optional X handle without @. |
| domains | array | optional | Optional competitor domains. |
| aliases | array | optional | Optional brand aliases. |
| exclude_terms | array | optional | Optional disambiguation exclude terms. |
| priority | integer | optional | Lower number wins when multiple competitors match. |
Plan access
Available on the free tier and above. Live tools draw from your team's monthly credit budget at parity with upstream API cost (1 credit ≈ $0.001).
See plans