API v1

Add competitors

Add competitor URLs to an existing project. Analysis kicks off immediately. A URL that cannot be counted as a rival (the company itself, its former or new name, its parent, a business it acquired, one no longer trading, a customer or partner on its own site) is not added and is listed in data.not_counted with the reason; when none can be added the reply is 400 NOT_A_RIVAL and nothing is started.

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

Request

  • Base URL: https://api.rivalize.ai
  • URL: https://api.rivalize.ai/api/v1/projects/{id}/competitors
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

urlsstring[] required

Competitor URLs to add and analyze. The number accepted is capped by your plan; exceeding it returns 409 COMPETITOR_LIMIT_REACHED.

Response

Default Response

dataobject

Changes

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