public-api

Manage Competitor Public

Manage a brand's competitor lists.

  • action='list': read the tracked and hidden competitor names (no competitor needed).
  • action='add': track a competitor by name (appended to brands.competitors).
  • action='remove': untrack a previously added competitor.
  • action='hide': hide a competitor from competitive views.
  • action='unhide': restore a hidden competitor.

Competitors are identified by name (a domain works too, it is stored as given). add/remove touch the tracked set; hide/unhide touch the hidden set.

post/competitors/manage

Request

  • Base URL: https://api.trakkr.ai
  • URL: https://api.trakkr.ai/competitors/manage
  • Auth: HTTP bearer

Request body

brand_idstring uuid required
action'list' | 'add' | 'remove' | 'hide' | 'unhide' required
competitorstring nullable

Response

Successful Response

brand_idstring required
actionstring nullable
competitorstring nullable
trackedstring[] nullable
hiddenstring[] nullable
already_trackedboolean nullable
already_hiddenboolean nullable

Changes

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