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

# Get Analysis Configuration & Details

> Retrieves complete configuration and details of a specific brand perception analysis, including
all brands studied, competitors, countries, personas, attributes, and current status.

An analysis contains the full research configuration: which brands are being studied (analysis brand + competitors),
which markets (countries), target personas, category attributes being tracked, and data collection settings. This
endpoint provides the essential context needed to understand what data is available and how to query metrics from
Samantha. Perfect for discovering analysis scope before diving into detailed metrics.

**When to use:** User wants to see analysis configuration details, understand which brands/competitors are included,
check which countries and personas are analyzed, view tracked attributes, get analysis metadata (name, dates, status),
or understand the scope before querying metrics data.

**Common user queries:**
- "Show me the details of the Running Shoes analysis"
- "What brands are in this analysis?"
- "Who are the competitors for Nike in this study?"
- "Which countries are included in the analysis?"
- "What personas are we tracking?"
- "Get the analysis configuration"
- "What attributes are being measured?"
- "Show me analysis metadata and settings"

**Returns:** Complete analysis object with configuration, brands, competitors, countries, personas, attributes,
and status.
Example: {"id": "uuid-123", "name": "Running Shoes Q1 2024", "status": "completed",
"analysis_brand": "Nike", "competitor_brands": ["Adidas", "New Balance", "Asics"],
"countries": ["US", "UK", "Germany"], "personas": ["Athletes", "Casual Runners"],
"attributes": ["comfort", "durability", "style", "price"], "category": "athletic footwear",
"created_at": "2024-01-15T10:00:00Z", "is_archived": false}

Required permission: `read:analysis`.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}
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/{id}:
    get:
      tags:
        - Analyses
      summary: Get Analysis Configuration & Details
      description: >-
        Retrieves complete configuration and details of a specific brand
        perception analysis, including

        all brands studied, competitors, countries, personas, attributes, and
        current status.


        An analysis contains the full research configuration: which brands are
        being studied (analysis brand + competitors),

        which markets (countries), target personas, category attributes being
        tracked, and data collection settings. This

        endpoint provides the essential context needed to understand what data
        is available and how to query metrics from

        Samantha. Perfect for discovering analysis scope before diving into
        detailed metrics.


        **When to use:** User wants to see analysis configuration details,
        understand which brands/competitors are included,

        check which countries and personas are analyzed, view tracked
        attributes, get analysis metadata (name, dates, status),

        or understand the scope before querying metrics data.


        **Common user queries:**

        - "Show me the details of the Running Shoes analysis"

        - "What brands are in this analysis?"

        - "Who are the competitors for Nike in this study?"

        - "Which countries are included in the analysis?"

        - "What personas are we tracking?"

        - "Get the analysis configuration"

        - "What attributes are being measured?"

        - "Show me analysis metadata and settings"


        **Returns:** Complete analysis object with configuration, brands,
        competitors, countries, personas, attributes,

        and status.

        Example: {"id": "uuid-123", "name": "Running Shoes Q1 2024", "status":
        "completed",

        "analysis_brand": "Nike", "competitor_brands": ["Adidas", "New Balance",
        "Asics"],

        "countries": ["US", "UK", "Germany"], "personas": ["Athletes", "Casual
        Runners"],

        "attributes": ["comfort", "durability", "style", "price"], "category":
        "athletic footwear",

        "created_at": "2024-01-15T10:00:00Z", "is_archived": false}


        Required permission: `read:analysis`.
      operationId: retrieve_analysis
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying this analysis.
          required: true
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the organization.
          required: true
        - in: query
          name: translate_to_en
          schema:
            type: boolean
            default: false
          description: >-
            If true and analysis language is not English, translates pros and
            cons to English.
        - 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:
                $ref: '#/components/schemas/Analysis'
          description: ''
      security:
        - Bearer: []
components:
  schemas:
    Analysis:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Created
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Modified
        created_by:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 255
        countries:
          type: array
          items:
            type: string
            maxLength: 255
        brand:
          type: string
          maxLength: 255
        category:
          type: string
          maxLength: 255
        competitors:
          type: array
          items:
            type: string
            maxLength: 255
        personas:
          type: array
          items:
            type: string
            maxLength: 255
        attributes:
          type: array
          items:
            type: string
            maxLength: 255
        is_archived:
          type: boolean
        archived_at:
          type: string
          format: date-time
          nullable: true
        active_clustering:
          type: boolean
        collect_end_date:
          type: string
          format: date
          nullable: true
        llm_providers:
          type: array
          items:
            type: string
            maxLength: 255
        llm_provider_versions: {}
        language:
          enum:
            - ar
            - da
            - de
            - en
            - es
            - eu
            - fi
            - fil
            - fr
            - he
            - hi
            - hu
            - id
            - it
            - ja
            - ko
            - nl
            - pl
            - pt
            - ro
            - sv
            - th
            - tr
            - ur
            - vi
            - zh
            - zh-TW
            - ''
          type: string
          description: |-
            * `ar` - ar
            * `da` - da
            * `de` - de
            * `en` - en
            * `es` - es
            * `eu` - eu
            * `fi` - fi
            * `fil` - fil
            * `fr` - fr
            * `he` - he
            * `hi` - hi
            * `hu` - hu
            * `id` - id
            * `it` - it
            * `ja` - ja
            * `ko` - ko
            * `nl` - nl
            * `pl` - pl
            * `pt` - pt
            * `ro` - ro
            * `sv` - sv
            * `th` - th
            * `tr` - tr
            * `ur` - ur
            * `vi` - vi
            * `zh` - zh
            * `zh-TW` - zh TW
          x-spec-enum-id: eb433b6ba098186f
        is_boost:
          type: boolean
        generation_cost:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
      required:
        - brand
        - category
        - created_at
        - created_by
        - id
        - name
        - updated_at
        - workspace_id
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````