# 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.

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Competitors"}],"servers":[{"url":"https://api.airops.com","variables":{"defaultHost":{"default":"api.airops.com"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/public_api/brand_kits/{brand_kit_id}/competitors/list":{"post":{"summary":"List Competitors","description":"Competitors are the companies that are competing with the brand. They are used to track the performance of the brand against its competitors.","tags":["Competitors"],"operationId":"listBrandKitsCompetitors","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true,"type":"integer","description":"Unique identifier for the competitor"},"aeo_domain_id":{"nullable":true,"type":"integer","description":"Domain ID used for filtering citations by competitor"},"name":{"nullable":true,"type":"string","description":"Name of the competitor"},"domain_url":{"nullable":true,"type":"string","description":"Domain URL of the competitor"},"created_at":{"nullable":true,"type":"string","description":"When the competitor was created"}}}},"meta":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}}}},"required":["data","meta"]}}}},"400":{"description":"Bad request - invalid parameters, filters, or sort options"},"401":{"description":"Unauthorized - invalid or missing authentication token"},"404":{"description":"Not found - resource does not exist"},"412":{"description":"Precondition failed - AEO not configured for this brand kit"}},"parameters":[{"name":"brand_kit_id","in":"path","required":true,"schema":{"type":"integer"},"description":"The Brand Kit ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brand_kit_id":{"type":"integer","description":"The ID of the Brand Kit"},"filters":{"type":"array","description":"Filter results.\n\n**Available fields:**\n- **name** (EQUALS, CONTAINS): Filter by competitor name","items":{"type":"object","properties":{"field":{"type":"string","enum":["name"],"description":"Field to filter on. name: Filter by competitor name"},"operator":{"type":"string","enum":["EQUALS","CONTAINS"],"description":"Filter operator.\n\n- **EQ/EQUALS**: Exact match\n- **NEQ**: Not equal\n- **GT/GEQ/LT/LEQ**: Numeric/date comparisons\n- **CONTAINS**: Partial text match\n- **STARTS_WITH**: Text prefix match\n- **IN**: Match any value in array"},"value":{"description":"Filter value (type depends on field and operator)"}},"required":["field","operator","value"]}},"fields":{"type":"array","description":"Select additional fields to return.\n\n**Optional fields:**\n- **id**: Unique identifier for the competitor\n- **aeo_domain_id**: Domain ID used for filtering citations by competitor\n- **name**: Name of the competitor\n- **domain_url**: Domain URL of the competitor\n- **created_at**: When the competitor was created","items":{"type":"string","enum":["id","aeo_domain_id","name","domain_url","created_at"]}},"sort":{"type":"string","enum":["name","-name","created_at","-created_at"],"description":"Sort field. Prefix with - for descending.\n\n**Available sort fields:**\n- **name/-name**: Sort alphabetically by competitor name\n- **created_at/-created_at**: Sort by creation date"},"page":{"type":"integer","default":1,"description":"Page number"},"per_page":{"type":"integer","default":25,"maximum":100,"description":"Items per page"}},"required":["brand_kit_id"]}}}}}}}}
```

## Get Competitor

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

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Competitors"}],"servers":[{"url":"https://api.airops.com","variables":{"defaultHost":{"default":"api.airops.com"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/public_api/brand_kits/{brand_kit_id}/competitors/{id}":{"get":{"summary":"Get Competitor","description":"Competitors are the companies that are competing with the brand. They are used to track the performance of the brand against its competitors.","tags":["Competitors"],"operationId":"getBrandKitsCompetitor","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"nullable":true,"type":"integer","description":"Unique identifier for the competitor"},"aeo_domain_id":{"nullable":true,"type":"integer","description":"Domain ID used for filtering citations by competitor"},"name":{"nullable":true,"type":"string","description":"Name of the competitor"},"domain_url":{"nullable":true,"type":"string","description":"Domain URL of the competitor"},"created_at":{"nullable":true,"type":"string","description":"When the competitor was created"}}}},"required":["data"]}}}},"400":{"description":"Bad request - invalid parameters, filters, or sort options"},"401":{"description":"Unauthorized - invalid or missing authentication token"},"404":{"description":"Not found - resource does not exist"},"412":{"description":"Precondition failed - AEO not configured for this brand kit"}},"parameters":[{"name":"brand_kit_id","in":"path","required":true,"schema":{"type":"integer"},"description":"The Brand Kit ID"},{"name":"id","in":"path","required":true,"schema":{"type":"integer"},"description":"The resource ID"}]}}}}
```