List Brand Analyses in Workspace

Retrieves all brand perception analyses within a workspace, showing which AI recommendation studies have been conducted and their current status. An analysis represents a comprehensive study of how AI models recommend brands in a specific category (e.g., "best running shoes" or "top smartphones"). Each analysis contains brand awareness metrics, strengths/weaknesses, positioning data, and competitive insights. This endpoint returns metadata about all analyses in a workspace, enabling users to discover available studies, check analysis status, and access completed research. **When to use:** User wants to see available brand analyses, list all studies in a workspace, find a specific analysis by name, check analysis completion status, discover what data is available, or get an overview of all brand research conducted. **Common user queries:** - "What analyses do we have?" - "List all brand studies" - "Show me available analyses" - "Which analyses are completed?" - "What brand research has been done?" - "Get all analyses in this workspace" - "Find analysis for running shoes" - "Show me analysis history" **Returns:** Array of analysis objects with metadata (id, name, status, dates, settings). Example: [{"id": "uuid-123", "name": "Running Shoes Q1 2024", "status": "completed", "created_at": "2024-01-15T10:00:00Z", "brands": ["Nike", "Adidas", "New Balance"], "countries": ["US"], "is_archived": false}] Required permission: `read:analysis`.

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

List Brand Analyses in Workspace

cURL

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses \
  --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

organization_id · string<uuid> · required

A UUID string identifying the organization.

workspace_id · string<uuid> · required

A UUID string identifying the workspace.

Query Parameters

include_email · boolean

Include email of the analysis creator if True.

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