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

# Collected Search Queries Data

> Get all the raw search queries data collected for a project.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/collects/search-queries
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}/analyses/{project_id}/search/collects/search-queries:
    get:
      tags:
        - Collects
      summary: Collected Search Queries Data
      description: Get all the raw search queries data collected for a project.
      operationId: list_collected_search_queries_metrics
      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: project_id
          in: path
          required: true
          schema:
            type: string
            title: Project Id
        - name: competitor_types
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CompetitorTypeEnum'
            nullable: true
            title: Competitor Types
        - 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
        - name: date_start
          in: query
          required: true
          schema:
            type: string
            format: date
            description: Start of the date range (YYYY-MM-DD)
            title: Date Start
          description: Start of the date range (YYYY-MM-DD)
        - name: date_end
          in: query
          required: false
          schema:
            type: string
            format: date
            nullable: true
            description: >-
              End of the date range (YYYY-MM-DD). Defaults to end of period
              containing date_start.
            title: Date End
          description: >-
            End of the date range (YYYY-MM-DD). Defaults to end of period
            containing date_start.
        - name: period
          in: query
          required: false
          schema:
            enum:
              - day
              - week
              - month
              - year
            type: string
            description: 'Aggregation period: day, week, month, or year'
            default: week
            title: Period
          description: 'Aggregation period: day, week, month, or year'
        - name: sources
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/SourcesEnum'
            nullable: true
            title: Sources
        - name: thematics
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            nullable: true
            description: Filter by a list of thematic IDs
            title: Thematics
          description: Filter by a list of thematic IDs
        - name: keyword_type
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/KeywordOverviewMetricTypeEnum'
            nullable: true
            description: Filter by a list of keyword types
            title: Keyword Type
          description: Filter by a list of keyword types
        - name: funnel_stages
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/FunnelStage'
            nullable: true
            description: Filter by a list of Funnel Stages
            title: Funnel Stages
          description: Filter by a list of Funnel Stages
        - name: persona_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            nullable: true
            description: Filter by a list of persona IDs
            title: Persona Ids
          description: Filter by a list of persona IDs
        - name: topic_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            nullable: true
            description: Filter by a list of topic IDs
            title: Topic Ids
          description: Filter by a list of topic IDs
        - name: get_neutrals
          in: query
          required: false
          schema:
            type: boolean
            nullable: true
            description: >-
              Filter by to get results related to neutral prompts, without
              weakness or strength
            title: Get Neutrals
          description: >-
            Filter by to get results related to neutral prompts, without
            weakness or strength
        - name: strength_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            nullable: true
            description: Filter by a list of strength IDs
            title: Strength Ids
          description: Filter by a list of strength IDs
        - name: weakness_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            nullable: true
            description: Filter by a list of weakness IDs
            title: Weakness Ids
          description: Filter by a list of weakness IDs
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_CollectedKeywordItemResponse_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    CompetitorTypeEnum:
      type: string
      enum:
        - BRANDED_WEBSITE
        - COMMUNITY_HELP_CENTER
        - COMPARISON_SITE
        - GOVERNMENT_ACADEMIC
        - INFLUENCER_CREATOR_BLOG
        - NEWS_MEDIA
        - PRODUCT_REVIEW_SITE
        - QA_FORUM
        - RETAIL_ECOMMERCE
        - SPECIALIST_BLOG
        - WIKI_ENCYCLOPEDIA
        - UNKNOWN
      title: CompetitorTypeEnum
    SourcesEnum:
      type: string
      enum:
        - Bing
        - BingAIO
        - ChatGPT
        - Perplexity
        - Google
        - GoogleAIO
        - GoogleAIMode
        - Claude
        - Gemini
        - AmazonRufus
      title: SourcesEnum
    KeywordOverviewMetricTypeEnum:
      type: string
      enum:
        - Generic
        - Brand
      title: KeywordOverviewMetricTypeEnum
    FunnelStage:
      type: string
      enum:
        - ToFu
        - MoFu
        - BoFu
      title: FunnelStage
    PaginatedResponse_CollectedKeywordItemResponse_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CollectedKeywordItemResponse'
          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[CollectedKeywordItemResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CollectedKeywordItemResponse:
      properties:
        collect_id:
          type: string
          title: Collect Id
          description: ID of the collect run this result belongs to.
        keyword_id:
          type: string
          title: Keyword Id
          description: ID of the keyword these insights apply to.
        trends:
          items:
            type: number
          type: array
          title: Trends
          description: >-
            Time series of relative search interest values (0-100) for this
            keyword over the collect period.
        related_queries:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Related Queries
          description: >-
            List of related search queries associated with this keyword, as
            returned by the data source.
        intents:
          items:
            type: string
          type: array
          title: Intents
          description: >-
            Detected search intents for this keyword (e.g. 'informational',
            'navigational', 'transactional').
        search_interest_score:
          type: integer
          nullable: true
          title: Search Interest Score
          description: >-
            Aggregate search interest score (0-100) summarising the trend values
            for this keyword.
        search_volumes:
          type: integer
          nullable: true
          title: Search Volumes
          description: Estimated monthly search volume for this keyword.
      type: object
      required:
        - collect_id
        - keyword_id
        - trends
        - related_queries
        - intents
      title: CollectedKeywordItemResponse
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````