> ## 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 By Id > Get full analysis details including thematics, keywords, and tags by analysis ID. Requires read access to the workspace. ## OpenAPI ````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses/{project_id} openapi: 3.0.3 info: title: Share Of Model API version: v1 description: >- ## Search The Share of Search API provides visibility, presence, and ranking metrics for tracked search and AI engine sources. Use it to analyse how a project performs across keywords, thematics, competitors, and ranked URLs over time. For the previous version of the API, see the [v1 documentation](https://api.shareofsearch.jplus.io/docs/v1). servers: - description: Search - Production API url: https://api.shareofsearch.jplus.io/ security: [] tags: - name: Projects description: >- Manage analyses (projects) within a workspace. Create new analyses and list existing ones. - name: Collects description: >- Access data collection runs and their raw results. List collect runs for an analysis, or retrieve the raw data captured during each run: domain rankings, brand mentions, keyword insights, and LLM/SERP responses. - name: Overview Metrics description: >- High-level, aggregated metrics that summarise the overall performance of an analysis. Use these endpoints to get a quick picture of visibility, presence, andranking across all keywords and sources. - name: Metrics description: >- Detailed, per-entity metrics for deep-diving into specific aspects of an analysis. Break down performance by domain, brand, keyword, URL, or competitor. - name: Insights description: >- Cross-project KPIs aggregated at the workspace level. These endpoints consolidate metrics from all active projects within a workspace to provide a unified view of visibility, mentions, citations, sentiment, and ranking. - name: Shopping description: >- Shopping-specific metrics for analyses that track product listings in shopping engines. Measure product visibility, pricing, merchant coverage, and share of shelf across all tracked keywords and sources. paths: /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses/{project_id}: get: tags: - Projects summary: Get Analysis By Id description: >- Get full analysis details including thematics, keywords, and tags by analysis ID. Requires read access to the workspace. operationId: get_search_visibility_analyse_by_id parameters: - name: project_id in: path required: true schema: type: string title: Project Id - name: organization_id in: path required: true schema: type: string title: Organization Id - name: workspace_id in: path required: true schema: type: string title: Workspace Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AnalysisDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: AnalysisDetailResponse: properties: id: type: string title: Id description: Unique identifier of the analysis. internal_id: type: string title: Internal Id description: UUID v4 unique identifier of the analysis. workspace_id: type: string nullable: true title: Workspace Id description: ID of the workspace this analysis belongs to. name: type: string nullable: true title: Name description: Display name of the analysis, if set. website: type: string title: Website description: Website being tracked by this analysis. brand: type: string title: Brand description: Primary brand name associated with the tracked website. brand_official_name: type: string nullable: true title: Brand Official Name description: >- Official legal or full name of the brand, if different from the display name. status: allOf: - $ref: '#/components/schemas/ProjectStatusEnum' description: Lifecycle status of the analysis. sources: items: $ref: '#/components/schemas/SourcesEnum' type: array title: Sources description: Search engines and AI sources monitored by this analysis. devices: items: $ref: '#/components/schemas/DevicesEnum' type: array title: Devices description: Device types for which results are collected. country: type: string title: Country description: >- Country code for which search results are collected (ISO 3166-1 alpha-2). language: type: string title: Language description: Language code used for queries in this analysis (BCP 47). frequency: allOf: - $ref: '#/components/schemas/FrequencyEnum' description: How often data collection runs. website_type: allOf: - $ref: '#/components/schemas/WebsiteType' nullable: true description: Type of website being tracked. Null if not specified. query_fanouts_enabled: type: boolean title: Query Fanouts Enabled description: >- Whether query fan-out (expanded query variants) is enabled for this analysis. shopping_enabled: type: boolean title: Shopping Enabled description: Whether shopping results are collected for this analysis. category: type: string title: Category description: Industry or vertical category this analysis belongs to. thematics: items: $ref: '#/components/schemas/AnalysisThematicResponse' type: array title: Thematics description: >- Thematic groups defined in this analysis, each containing topics with their keywords. personas: items: $ref: '#/components/schemas/AnalysisPersonaResponse' type: array title: Personas description: Personas defined for this analysis. default: [] related_products: items: $ref: '#/components/schemas/AnalysisRelatedProductResponse' type: array title: Related Products description: Products or services linked to this analysis. default: [] sub_brands: items: $ref: '#/components/schemas/AnalysisSubBrandResponse' type: array title: Sub Brands description: Sub-brands tracked within this analysis. default: [] perceptions: items: $ref: '#/components/schemas/AnalysisPerceptionResponse' type: array title: Perceptions description: Brand strengths and weaknesses defined for this analysis. default: [] created_at: type: string title: Created At description: ISO 8601 timestamp of when this analysis was created. updated_at: type: string title: Updated At description: ISO 8601 timestamp of when this analysis was last updated. type: object required: - id - internal_id - website - brand - status - sources - devices - country - language - frequency - query_fanouts_enabled - shopping_enabled - category - thematics - created_at - updated_at title: AnalysisDetailResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ProjectStatusEnum: type: string enum: - NEW - RUNNING - ACTIVE - DELETED - PAUSED title: ProjectStatusEnum SourcesEnum: type: string enum: - Bing - BingAIO - ChatGPT - Perplexity - Google - GoogleAIO - GoogleAIMode - Claude - Gemini - AmazonRufus title: SourcesEnum DevicesEnum: type: string enum: - DESKTOP - MOBILE - TABLET title: DevicesEnum FrequencyEnum: type: string enum: - MONTHLY - WEEKLY - DAILY - ONCE title: FrequencyEnum WebsiteType: type: string enum: - DOMAIN - SUBDOMAIN title: WebsiteType AnalysisThematicResponse: properties: id: type: string title: Id description: Unique identifier of the thematic group. name: type: string title: Name description: Display name of the thematic group. color: type: string title: Color description: Hex colour code used to represent this thematic in the UI. topics: items: $ref: '#/components/schemas/AnalysisTopicResponse' type: array title: Topics description: Topics defined within this thematic group. default: [] type: object required: - id - name - color title: AnalysisThematicResponse AnalysisPersonaResponse: properties: id: type: string title: Id description: Unique identifier of the persona. label: type: string title: Label description: Short display name for the persona. description: type: string title: Description description: Longer description of the persona's profile and characteristics. core_needs: items: type: string type: array title: Core Needs description: Key needs or motivations associated with this persona. default: [] pain_points: items: type: string type: array title: Pain Points description: Challenges or frustrations associated with this persona. default: [] type: object required: - id - label - description title: AnalysisPersonaResponse AnalysisRelatedProductResponse: properties: id: type: string title: Id description: Unique identifier of the related product. name: type: string title: Name description: Name of the product or service related to this analysis. type: object required: - id - name title: AnalysisRelatedProductResponse AnalysisSubBrandResponse: properties: id: type: string title: Id description: Unique identifier of the sub-brand. name: type: string title: Name description: Name of the sub-brand. type: object required: - id - name title: AnalysisSubBrandResponse AnalysisPerceptionResponse: properties: id: type: string title: Id description: Unique identifier of the perception entry. value: type: string title: Value description: Text describing the perceived strength or weakness. type: type: string enum: - strength - weakness title: Type description: Whether this perception is a brand strength or a brand weakness. type: object required: - id - value - type title: AnalysisPerceptionResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError AnalysisTopicResponse: properties: id: type: string title: Id description: Unique identifier of the topic. thematic_id: type: string title: Thematic Id description: ID of the thematic group this topic belongs to. text: type: string title: Text description: Label or name of the topic. keywords: items: $ref: '#/components/schemas/AnalysisKeywordResponse' type: array title: Keywords description: Keywords assigned to this topic. default: [] type: object required: - id - thematic_id - text title: AnalysisTopicResponse AnalysisKeywordResponse: properties: id: type: string title: Id description: Unique identifier of the keyword. text: type: string title: Text description: Keyword text as it is tracked and queried. brand_type: type: string nullable: true title: Brand Type description: >- Brand classification of the keyword (e.g. 'branded', 'competitor', 'generic'). Null if unclassified. type: object required: - id - text title: AnalysisKeywordResponse securitySchemes: HTTPBearer: type: http scheme: bearer ````