> ## Documentation Index > Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt > Use this file to discover all available pages before exploring further. # Competitor Brands > Retrieves brands appearing in search and AI results, with aggregated metrics for a given date range. Filter by brand name, competitor type, source, thematic, keyword type, and more. Supports sorting by: brand, visibility_score, total_mentions, presence_rate, avg_ranking. NULL values are treated as below 0 in ascending order. ## OpenAPI ````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/brands openapi: 3.0.3 info: title: Share Of Model API version: v1 description: >- ## Search The Share of Search API provides visibility, presence, and ranking metrics for tracked search and AI engine sources. Use it to analyse how a project performs across keywords, thematics, competitors, and ranked URLs over time. For the previous version of the API, see the [v1 documentation](https://api.shareofsearch.jplus.io/docs/v1). servers: - description: Search - Production API url: https://api.shareofsearch.jplus.io/ security: [] tags: - name: Projects description: >- Manage analyses (projects) within a workspace. Create new analyses and list existing ones. - name: Collects description: >- Access data collection runs and their raw results. List collect runs for an analysis, or retrieve the raw data captured during each run: domain rankings, brand mentions, keyword insights, and LLM/SERP responses. - name: Overview Metrics description: >- High-level, aggregated metrics that summarise the overall performance of an analysis. Use these endpoints to get a quick picture of visibility, presence, andranking across all keywords and sources. - name: Metrics description: >- Detailed, per-entity metrics for deep-diving into specific aspects of an analysis. Break down performance by domain, brand, keyword, URL, or competitor. - name: Insights description: >- Cross-project KPIs aggregated at the workspace level. These endpoints consolidate metrics from all active projects within a workspace to provide a unified view of visibility, mentions, citations, sentiment, and ranking. - name: Shopping description: >- Shopping-specific metrics for analyses that track product listings in shopping engines. Measure product visibility, pricing, merchant coverage, and share of shelf across all tracked keywords and sources. paths: /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/brands: get: tags: - Metrics summary: Competitor Brands description: >- Retrieves brands appearing in search and AI results, with aggregated metrics for a given date range. Filter by brand name, competitor type, source, thematic, keyword type, and more. Supports sorting by: brand, visibility_score, total_mentions, presence_rate, avg_ranking. NULL values are treated as below 0 in ascending order. operationId: list_brands parameters: - name: organization_id in: path required: true schema: type: string title: Organization Id - name: workspace_id in: path required: true schema: type: string title: Workspace Id - name: project_id in: path required: true schema: type: string title: Project Id - name: brands in: query required: false schema: type: array items: type: string nullable: true description: Brands to filter by title: Brands description: Brands to filter by - name: competitor_types in: query required: false schema: type: array items: $ref: '#/components/schemas/CompetitorTypeEnum' nullable: true title: Competitor Types - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: page_size in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 20 title: Page Size - name: search_query in: query required: false schema: type: string nullable: true title: Search Query - name: sort_column in: query required: false schema: allOf: - $ref: '#/components/schemas/TopBrandsSortColumnEnum' nullable: true title: Sort Column - name: sort_direction in: query required: false schema: allOf: - $ref: '#/components/schemas/TopBrandsSortDirectionEnum' nullable: true title: Sort Direction - name: date_start in: query required: true schema: type: string format: date description: Start of the date range (YYYY-MM-DD) title: Date Start description: Start of the date range (YYYY-MM-DD) - name: date_end in: query required: false schema: type: string format: date nullable: true description: >- End of the date range (YYYY-MM-DD). Defaults to end of period containing date_start. title: Date End description: >- End of the date range (YYYY-MM-DD). Defaults to end of period containing date_start. - name: period in: query required: false schema: enum: - day - week - month - year type: string description: 'Aggregation period: day, week, month, or year' default: week title: Period description: 'Aggregation period: day, week, month, or year' - name: sources in: query required: false schema: type: array items: $ref: '#/components/schemas/SourcesEnum' nullable: true title: Sources - name: thematics in: query required: false schema: type: array items: type: string format: uuid nullable: true description: Filter by a list of thematic IDs title: Thematics description: Filter by a list of thematic IDs - name: keyword_type in: query required: false schema: type: array items: $ref: '#/components/schemas/KeywordOverviewMetricTypeEnum' nullable: true description: Filter by a list of keyword types title: Keyword Type description: Filter by a list of keyword types - name: funnel_stages in: query required: false schema: type: array items: $ref: '#/components/schemas/FunnelStage' nullable: true description: Filter by a list of Funnel Stages title: Funnel Stages description: Filter by a list of Funnel Stages - name: persona_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of persona IDs title: Persona Ids description: Filter by a list of persona IDs - name: topic_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of topic IDs title: Topic Ids description: Filter by a list of topic IDs - name: get_neutrals in: query required: false schema: type: boolean nullable: true description: >- Filter by to get results related to neutral prompts, without weakness or strength title: Get Neutrals description: >- Filter by to get results related to neutral prompts, without weakness or strength - name: strength_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of strength IDs title: Strength Ids description: Filter by a list of strength IDs - name: weakness_ids in: query required: false schema: type: array items: type: string nullable: true description: Filter by a list of weakness IDs title: Weakness Ids description: Filter by a list of weakness IDs responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_CompetitorBrand_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: CompetitorTypeEnum: type: string enum: - BRANDED_WEBSITE - COMMUNITY_HELP_CENTER - COMPARISON_SITE - GOVERNMENT_ACADEMIC - INFLUENCER_CREATOR_BLOG - NEWS_MEDIA - PRODUCT_REVIEW_SITE - QA_FORUM - RETAIL_ECOMMERCE - SPECIALIST_BLOG - WIKI_ENCYCLOPEDIA - UNKNOWN title: CompetitorTypeEnum TopBrandsSortColumnEnum: type: string enum: - brand - visibility_score - nb_mentions - nb_distinct_keywords - average_position - presence_rate title: TopBrandsSortColumnEnum TopBrandsSortDirectionEnum: type: string enum: - asc - desc title: TopBrandsSortDirectionEnum SourcesEnum: type: string enum: - Bing - BingAIO - ChatGPT - Perplexity - Google - GoogleAIO - GoogleAIMode - Claude - Gemini - AmazonRufus title: SourcesEnum KeywordOverviewMetricTypeEnum: type: string enum: - Generic - Brand title: KeywordOverviewMetricTypeEnum FunnelStage: type: string enum: - ToFu - MoFu - BoFu title: FunnelStage PaginatedResponse_CompetitorBrand_: properties: data: items: $ref: '#/components/schemas/CompetitorBrand' type: array title: Data description: Items for the current page. pagination: allOf: - $ref: '#/components/schemas/Pagination' description: Pagination metadata. type: object required: - data - pagination title: PaginatedResponse[CompetitorBrand] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CompetitorBrand: properties: brand: type: string title: Brand description: Brand name. total_mentions: allOf: - $ref: '#/components/schemas/Metric' description: >- Total number of times this brand appeared in results, compared to the previous period. visibility_score: allOf: - $ref: '#/components/schemas/Metric' description: Visibility score for this brand, compared to the previous period. avg_ranking: allOf: - $ref: '#/components/schemas/Metric' nullable: true description: >- Average rank position for this brand, compared to the previous period. Lower is better. presence_rate: allOf: - $ref: '#/components/schemas/Metric' description: >- Share of result slots in which this brand appeared at least once, compared to the previous period. presence_rate_total: allOf: - $ref: '#/components/schemas/Metric' description: >- Total number of SERP/AI result slots in scope for this brand's presence rate calculation, compared to the previous period. presence_rate_occurrences: allOf: - $ref: '#/components/schemas/Metric' description: >- Number of result slots in which this brand appeared, compared to the previous period. is_my_brand: type: boolean title: Is My Brand description: Whether this brand is the tracked brand for this project. competitor_type: allOf: - $ref: '#/components/schemas/CompetitorTypeEnum' description: Competitor category assigned to this brand. type: object required: - brand - total_mentions - visibility_score - presence_rate - presence_rate_total - presence_rate_occurrences - is_my_brand - competitor_type title: CompetitorBrand Pagination: properties: page: type: integer title: Page description: Current page number (1-based). page_size: type: integer title: Page Size description: Maximum number of items returned per page. total: type: integer title: Total description: Total number of items matching the query, across all pages. type: object required: - page - page_size - total title: Pagination ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError Metric: properties: value: type: number title: Value description: Current value for the selected period. prev_value: type: number nullable: true title: Prev Value description: >- Value for the previous comparable period. Null when no comparison period is available. unit: type: string nullable: true title: Unit description: >- Unit of the metric (e.g. '%', 'ms'). Null when the value is dimensionless. type: object required: - value title: Metric securitySchemes: HTTPBearer: type: http scheme: bearer ````