competitive-intelligence

Scan Competitor

Run a full competitive intelligence scan on a competitor. Persists results to the competitor record if it exists.

post/api/competitive-intel/scan

Request

  • Base URL: https://voyant.io (the document declares no server; this is the origin it was published from)
  • URL: https://voyant.io/api/competitive-intel/scan
  • Auth: HTTP bearer

Request body

namestring required

Competitor name

domainstring required

Competitor domain (e.g., confluent.io)

github_reposstring[] nullable

GitHub repos to monitor (e.g., ['confluentinc/ksql'])

reddit_keywordsstring[] nullable

Keywords to search on Reddit

Response

Successful Response

namestring required
domainstring required
scanned_atstring required
reddit_summaryobject nullable
overall_threat_levelstring
insightsstring[]

Changes

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