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

GET /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}

Get Analysis Configuration & Details

cURL

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id} \
  --header 'Authorization: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "brand": "<string>",
  "category": "<string>",
  "countries": [
    "<string>"
  ],
  "competitors": [
    "<string>"
  ],
  "personas": [
    "<string>"
  ],
  "attributes": [
    "<string>"
  ],
  "is_archived": true,
  "archived_at": "2023-11-07T05:31:56Z",
  "active_clustering": true,
  "collect_end_date": "2023-12-25",
  "llm_providers": [
    "<string>"
  ],
  "llm_provider_versions": "<unknown>",
  "is_boost": true,
  "generation_cost": -1
}

Authorizations

Authorization · string · header · required

Path Parameters

id · string<uuid> · required

A UUID string identifying this analysis.

organization_id · string<uuid> · required

A UUID string identifying the organization.

workspace_id · string<uuid> · required

A UUID string identifying the workspace.

Query Parameters

translate_to_en · boolean · default: false

If true and analysis language is not English, translates pros and cons to English.

Response

200 - application/json

id · string<uuid> · required · read-only

created_at · string<date-time> · required · read-only

updated_at · string<date-time> · required · read-only

created_by · string<uuid> · required

workspace_id · string<uuid> · required

name · string · required

Maximum string length: 255

brand · string · required

Maximum string length: 255

category · string · required

Maximum string length: 255

countries · string[]

Maximum string length: 255

competitors · string[]

Maximum string length: 255

personas · string[]

Maximum string length: 255

attributes · string[]

Maximum string length: 255

is_archived · boolean

archived_at · string<date-time> | null

active_clustering · boolean

collect_end_date · string<date> | null

llm_providers · string[]

Maximum string length: 255

llm_provider_versions · any

language · enum<string>

• 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

Available options: 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,

is_boost · boolean

generation_cost · integer

Required range: -2147483648 <= x <= 2147483647