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

# List All Analyses

> Paginated list of all analyses (projects) for a workspace. Use this endpoint to discover available analysis IDs for use with other endpoints. pagination.total is the total number of analyses across all pages.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses
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:
    get:
      tags:
        - Projects
      summary: List All Analyses
      description: >-
        Paginated list of all analyses (projects) for a workspace. Use this
        endpoint to discover available analysis IDs for use with other
        endpoints. pagination.total is the total number of analyses across all
        pages.
      operationId: list_search_visibility_analyses
      parameters:
        - 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
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_AnalysisListItemResponse_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PaginatedResponse_AnalysisListItemResponse_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/AnalysisListItemResponse'
          type: array
          title: Data
          description: Items for the current page.
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
          description: Pagination metadata.
      type: object
      required:
        - data
        - pagination
      title: PaginatedResponse[AnalysisListItemResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AnalysisListItemResponse:
      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.
        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.
        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.
        status:
          allOf:
            - $ref: '#/components/schemas/ProjectStatusEnum'
          description: Lifecycle status of the analysis.
        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).
        num_keywords:
          type: integer
          title: Num Keywords
          description: Total number of keywords tracked by this analysis.
        num_thematics:
          type: integer
          title: Num Thematics
          description: Number of thematic groups defined in this analysis.
        num_topics:
          type: integer
          title: Num Topics
          description: Number of topics defined across all thematics in this analysis.
        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.
        collect:
          allOf:
            - $ref: '#/components/schemas/AnalysisCollectResponse'
          nullable: true
          description: >-
            Most recent collect run for this analysis. Null if no collect has
            been triggered yet.
        created_by:
          type: string
          nullable: true
          title: Created By
          description: Email or identifier of the user who created this analysis.
        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
        - sources
        - devices
        - status
        - country
        - language
        - num_keywords
        - num_thematics
        - num_topics
        - frequency
        - query_fanouts_enabled
        - shopping_enabled
        - category
        - created_at
        - updated_at
      title: AnalysisListItemResponse
    Pagination:
      properties:
        page:
          type: integer
          title: Page
          description: Current page number (1-based).
        page_size:
          type: integer
          title: Page Size
          description: Maximum number of items returned per page.
        total:
          type: integer
          title: Total
          description: Total number of items matching the query, across all pages.
      type: object
      required:
        - page
        - page_size
        - total
      title: Pagination
    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
    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
    ProjectStatusEnum:
      type: string
      enum:
        - NEW
        - RUNNING
        - ACTIVE
        - DELETED
        - PAUSED
      title: ProjectStatusEnum
    FrequencyEnum:
      type: string
      enum:
        - MONTHLY
        - WEEKLY
        - DAILY
        - ONCE
      title: FrequencyEnum
    WebsiteType:
      type: string
      enum:
        - DOMAIN
        - SUBDOMAIN
      title: WebsiteType
    AnalysisCollectResponse:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the collect run.
        progress:
          type: integer
          title: Progress
          description: Completion progress of the collect run as a percentage (0–100).
        status:
          allOf:
            - $ref: '#/components/schemas/CollectStatusEnum'
          description: Current status of the collect run.
        type:
          allOf:
            - $ref: '#/components/schemas/CollectTypeEnum'
          description: Type of collect.
        date:
          type: string
          format: date-time
          nullable: true
          title: Date
          description: Date of this collect run.
      type: object
      required:
        - id
        - progress
        - status
        - type
      title: AnalysisCollectResponse
    CollectStatusEnum:
      type: string
      enum:
        - IN_PROGRESS
        - IN_PROGRESS_WITH_ERRORS
        - FINISHED
        - FINISHED_WITH_ERRORS
        - CANCELED
        - ERROR_INSUFFICIENT_CREDITS
      title: CollectStatusEnum
    CollectTypeEnum:
      type: string
      enum:
        - ENGINE
        - PROJECT_SETUP
        - FULL
        - SEMRUSH
      title: CollectTypeEnum
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````