Write

Run an AI keyword discovery scan on a competitor

Generates the search terms the competitor's listing is optimized for (brand terms included), queues them for SERP verification, and verifies the first batch inline (~30s); the rest verify in the background, recording both apps' ranks. Each org can scan a limited number of different competitors per UTC day (50 on trial and Indie, 250 on Agency); re-scanning a competitor already scanned today is free, and the background scan that runs when a competitor is added counts toward the same allowance. Requires the Indie plan and a write-scope API key.

post/api/v1/competitors/{id}/scan

Request

  • Base URL: https://api.trysonar.app
  • URL: https://api.trysonar.app/api/v1/competitors/{id}/scan
  • Auth: HTTP bearer

Path parameters

idstring required

Competitor's Sonar app UUID

Request body

own_app_idstring uuid required

Your own app the scan compares against

Response

Scan counts: { generated, queued, verified_now } — remaining candidates verify in the background; poll the competitor keywords endpoint for results

dataobject required

Result payload — full field reference at https://trysonar.app/docs/api

Changes

No recorded changes to this operation across all 1 revision of this API.