List Brand Analyses in Workspace
Analyses
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"], "personas": ["Athletes", "Casual Runners"],
"persona_ids": ["3f2b1c4e-8a7d-4e1f-9c2b-5d6a7e8f9a0b"], "is_archived": false}]
Every analysis carries both persona representations. `persona_ids` holds the ids of the persona records in
`/personas`; it is always present and is `[]` for analyses created before personas became first-class records.
`personas` is the legacy display field the collection pipeline reads, and it holds **either** free text
**or** the id of a persona record as a string — an analysis created from the persona library mirrors its ids
into it, since that field is the only persona channel the pipeline can read. Resolve an entry that parses as
a UUID through `/personas`; treat anything else as a label. The two are filtered separately —
`persona_ids`, `persona_ids_all` and `has_persona_ids` below work on the ids only.
Required permission: `read:analysis`.
GET
List Brand Analyses in Workspace
Authorizations
Path Parameters
A UUID string identifying the organization.
A UUID string identifying the workspace.
Query Parameters
true returns records linked to at least one persona, false records with an empty persona_ids.
Include email of the analysis creator if True.
Response
200 - application/json
Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255ar- arda- dade- deen- enes- eseu- eufi- fifil- filfr- frhe- hehi- hihu- huid- idit- itja- jako- konl- nlpl- plpt- ptro- rosv- svth- thtr- trur- urvi- vizh- zhzh-TW- zh TWzh-HK- zh HK
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, zh-HK, Required range:
-2147483648 <= x <= 2147483647