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

# List All Attributes with Cluster Mapping

> Provides a complete mapping of every detailed attribute to its parent cluster th
                   eme, showing the granular details that compose each high-level perception.

Clusters group similar attributes together. For example, the
'Comfort' cluster might contain attributes like 'soft', 'cushioned', 'ergonomic', 'cozy'. This endpoint lists all these detailed attributes and shows which cluster each belongs to. Essential for understanding the detailed components that make up each theme.

**When to use:** User wants to see detailed attributes within a cluster, understand what specific terms compose each theme, explore the granular data behind cluster aggregations, or map detailed mentions to high-level themes.

**Common user queries:**
- "What attributes are in the comfort cluster?"
- "Show me all the detailed pros attributes"
- "List the specific mentions grouped under each theme"
- "What detailed terms make up the quality cluster?"
- "Get attribute-to-cluster mapping"

**Returns:** Array of objects with attribute names and their associated cluster.
Example: [{"attribute": "soft", "cluster": "Comfortable"}, {"attribute": "cushioned",
"cluster": "Comfortable"}, {"attribute": "fast", "cluster": "Sporty"}]

Required permission: `read:analysis`.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/get_cluster_attributes
openapi: 3.0.3
info:
  title: Share Of Model API
  version: v1
  description: >-
    ## Model Context Protocol (MCP)


    In addition to this REST API, Share of Model exposes a **Model Context
    Protocol** server that lets AI assistants (Claude Desktop, Claude Code, MCP
    Inspector, custom agents…) call our endpoints directly as tools. Any
    MCP-compatible client can interact with Share of Model without writing
    custom integration code — connect once with your usual login and start
    asking the assistant to query the data for you.


    ### Connecting from Claude Desktop


    Open **Settings → Connectors**, scroll to the bottom and click **Add custom
    connector**, then paste `https://mcp.shareofmodel.ai/mcp/`. A browser window
    opens for you to log in with your Share of Model account (same login as the
    web app), and the assistant gains access to the tools.


    ### Connecting from Claude Code


    ```bash

    claude mcp add --transport http share-of-model
    https://mcp.shareofmodel.ai/mcp/

    ```


    The first time you call a tool, Claude Code opens your browser to complete
    the login.


    ### Connecting from MCP Inspector


    ```bash

    npx @modelcontextprotocol/inspector

    ```


    In the Inspector UI, pick **Streamable HTTP** as transport, paste
    `https://mcp.shareofmodel.ai/mcp/`, and click **Connect**. The first
    connection prompts you to log in.


    ### Available tools


    Only endpoints tagged `mcp` in this OpenAPI spec are exposed as MCP tools,
    and only read-only (`GET`) routes are exposed. Everything tagged `mcp` below
    is callable from any compliant MCP client.


    ### Example prompts


    Once connected, try asking your assistant things like:


    - _"List the workspaces I have access to."_

    - _"Show me the latest searches in workspace X."_

    - _"Compare the share of model between brand A and brand B over the last 30
    days."_


    For more details on the protocol itself, see the [Model Context Protocol
    specification](https://modelcontextprotocol.io/).
servers:
  - description: Production API
    url: https://api.shareofmodel.ai/
  - description: Development API
    url: https://api.dev.shareofmodel.ai/
security: []
tags:
  - name: Auth
    description: Endpoints needed for API authentication.
  - name: Organizations
    description: Endpoints related to organizations, to list all available organizations.
  - name: Workspaces
    description: Endpoints related to workspaces, to list all available workspaces.
  - name: Analyses
    description: Endpoints related to analyses and analyses management.
  - name: Asset Evaluations
    description: Endpoints related to assets and asset evaluations.
  - name: Brand Catalog
    description: Endpoints related to general brand information.
  - name: Content Briefs
    description: Endpoints related to content briefs generation and optimisation.
  - name: Metrics
    description: >+
      Endpoints related to brand metrics.


      **LEXICON**



      **Brand Awareness**: What opinion the LLMs have concerning specific
      brands, related to certain categories.



      **Brand Perception**: The general sentiment of the LLMs towards a brand,

      based on the pros and cons they mention.

paths:
  /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/get_cluster_attributes:
    get:
      tags:
        - Metrics
      summary: List All Attributes with Cluster Mapping
      description: >-
        Provides a complete mapping of every detailed attribute to its parent
        cluster th
                           eme, showing the granular details that compose each high-level perception.

        Clusters group similar attributes together. For example, the

        'Comfort' cluster might contain attributes like 'soft', 'cushioned',
        'ergonomic', 'cozy'. This endpoint lists all these detailed attributes
        and shows which cluster each belongs to. Essential for understanding the
        detailed components that make up each theme.


        **When to use:** User wants to see detailed attributes within a cluster,
        understand what specific terms compose each theme, explore the granular
        data behind cluster aggregations, or map detailed mentions to high-level
        themes.


        **Common user queries:**

        - "What attributes are in the comfort cluster?"

        - "Show me all the detailed pros attributes"

        - "List the specific mentions grouped under each theme"

        - "What detailed terms make up the quality cluster?"

        - "Get attribute-to-cluster mapping"


        **Returns:** Array of objects with attribute names and their associated
        cluster.

        Example: [{"attribute": "soft", "cluster": "Comfortable"}, {"attribute":
        "cushioned",

        "cluster": "Comfortable"}, {"attribute": "fast", "cluster": "Sporty"}]


        Required permission: `read:analysis`.
      operationId: cluster_attributes
      parameters:
        - in: path
          name: analysis_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the analysis.
          required: true
        - in: query
          name: cluster_group
          schema:
            type: string
            enum:
              - all_cons
              - all_pros
          description: Filter by one specific cluster group.
          required: true
        - in: query
          name: format
          schema:
            type: string
            enum:
              - csv
              - json
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the organization.
          required: true
        - in: path
          name: workspace_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the workspace.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterAttributes'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterAttributes'
          description: ''
      security:
        - Bearer: []
components:
  schemas:
    ClusterAttributes:
      type: object
      description: Base class with necessary methods overridden
      properties:
        attribute:
          type: string
        cluster:
          type: string
      required:
        - attribute
        - cluster
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````