Sign in

v1

latestOpenAPI 3.0.12026-07-2318588.1 KB
Competitors

List Competitors

Competitors are the companies that are competing with the brand. They are used to track the performance of the brand against its competitors.

post/public_api/brand_kits/{brand_kit_id}/competitors/list

Path parameters

brand_kit_idinteger required

The Brand Kit ID

Request body

brand_kit_idinteger required

The ID of the Brand Kit

fieldsstring[]

Select additional fields to return.

Optional fields:

  • id: Unique identifier for the competitor
  • aeo_domain_id: Domain ID used for filtering citations by competitor
  • name: Name of the competitor
  • domain_url: Domain URL of the competitor
  • created_at: When the competitor was created
sort'name' | '-name' | 'created_at' | '-created_at'

Sort field. Prefix with - for descending.

Available sort fields:

  • name/-name: Sort alphabetically by competitor name
  • created_at/-created_at: Sort by creation date
pageinteger

Page number

per_pageinteger

Items per page

Response

Successful response