> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/api-reference-1/brand-kits/competitors.md).

# 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. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`.\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\n- **HAS_ALL**: (tags filter) match only items having every listed value\n- **NOT_IN**: (tags filter) match only items having none of the listed values"},"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"}]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.airops.com/api-reference-1/brand-kits/competitors.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.