competitor-tracking

Setup Competitors

Add competitor rows quickly and enqueue the slow setup/scan work.

The UI polls persisted scan state from /status. Keeping the initial HTTP request lightweight avoids ALB 504s when crawling, ad scanning, and enrichment take multiple minutes.

post/api/competitor-tracking/setup

Request

Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
URL: https://api.usepomo.ai/api/competitor-tracking/setup
Auth: HTTP bearer

Request body

competitor_urlsstring[] required

List of competitor website URLs (max 10)

Response

Successful Response

idstring uuid required

namestring required

domainstring required

logo_urlstring nullable

industrystring nullable

descriptionstring nullable

categoriesstring[] nullable

subcategoriesstring[] nullable

business_characteristicsstring[] nullable

target_marketstring[] nullable

statusstring required

tracking_enabledboolean

last_scanned_atstring date-time nullable

active_campaigns_countinteger

is_selfboolean

company_sizestring nullable

operating_regionsstring[] nullable

match_scoreinteger nullable

match_percentageinteger nullable

match_breakdownobject nullable

audience_overlap_scoreinteger nullable

offer_overlap_scoreinteger nullable

positioning_overlap_scoreinteger nullable

scoring_metadataobject nullable

discovery_metadataobject nullable

website_urlstring nullable

contact_page_urlstring nullable

facebook_urlstring nullable

instagram_handlestring nullable

linkedin_urlstring nullable

twitter_handlestring nullable

tiktok_urlstring nullable

youtube_urlstring nullable

is_scanningboolean

last_scan_started_atstring date-time nullable

last_scan_completed_atstring date-time nullable

setup_pendingboolean

restoredboolean

Changes

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