API v1

Trigger report

Trigger a new competitive intelligence report. Returns 202 Accepted with a report ID for polling.

post/api/v1/reports

Request

  • Base URL: https://api.rivalize.ai
  • URL: https://api.rivalize.ai/api/v1/reports
  • Auth: HTTP bearer

Request body

product_urlstring uri required

Your product URL

competitor_urlsstring[] required

Competitor URLs to analyze, up to your plan's per-report competitor limit. Duplicates of the same company and your own product URL are dropped before anything is charged, and listed in data.dropped. PRD-26: pass [] to run self-report mode (product URL only, no comparison).

depth'full' | 'quick'

Report depth (default: full). full is full research, charged 15 credits per 5 competitors started. quick is the quick check, charged 1 credit per competitor (minimum 1): it reads public pages only and leaves search traffic, follower counts and the written note on each company blank. A quick check does not use up the monthly report cap.

report_tier'standard' | 'pro'

Deprecated and ignored: every report triggered here runs at the depth in depth.

Response

Default Response

Changes

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