> ## Documentation Index
> Fetch the complete documentation index at: https://docs.citino.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List engine searches

> The web searches AI engines ran before answering the project's questions, or with view=terms the words in them.



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{projectId}/searches
openapi: 3.1.0
info:
  title: Citino API
  version: v1
  description: >-
    Read how AI engines answer your market's questions, and keep your prompts,
    competitors, segments and engines in step from code. Every number carries
    its band and sample size.
servers:
  - url: https://api.citino.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Brand and competitors
  - name: Definitions
  - name: Engines
  - name: Projects
  - name: Alerts
  - name: Attribution
  - name: Claims
  - name: Crawlability
  - name: Crawler activity
  - name: Metrics
  - name: Experiments
  - name: Prompts
  - name: Objections
  - name: Monthly reports
  - name: Reports
  - name: Runs
  - name: Searches
  - name: Sources
  - name: Work items
  - name: Settings
paths:
  /projects/{projectId}/searches:
    get:
      tags:
        - Searches
      summary: List engine searches
      description: >-
        The web searches AI engines ran before answering the project's
        questions, or with view=terms the words in them.
      operationId: getProjectsByProjectIdSearches
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
        - name: window
          in: query
          required: false
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - 90d
              - 180d
              - 365d
              - custom
        - name: from
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: to
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: segments
          in: query
          required: false
          schema:
            type: string
        - name: engines
          in: query
          required: false
          schema:
            type: string
        - name: view
          in: query
          required: false
          schema:
            type: string
            enum:
              - searches
              - terms
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{1,3}$
        - name: format
          in: query
          required: false
          schema:
            type: string
            enum:
              - json
              - csv
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  scope:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                    description: The scope the counts are over, with its sentence.
                  coverage:
                    type: object
                    properties:
                      reporting:
                        type: array
                        items:
                          type: string
                      not_reporting:
                        type: array
                        items:
                          type: string
                    required:
                      - reporting
                      - not_reporting
                    additionalProperties: false
                  items:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            query:
                              type: string
                            answers:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            prompts:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            engines:
                              type: array
                              items:
                                type: string
                            is_new:
                              type: boolean
                          required:
                            - query
                            - answers
                            - prompts
                            - engines
                            - is_new
                          additionalProperties: false
                        - type: object
                          properties:
                            term:
                              type: string
                            answers:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            searches:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                          required:
                            - term
                            - answers
                            - searches
                          additionalProperties: false
                  next_cursor:
                    type:
                      - string
                      - 'null'
                  has_more:
                    type: boolean
                required:
                  - scope
                  - coverage
                  - items
                  - next_cursor
                  - has_more
                additionalProperties: false
              example:
                scope:
                  window: custom
                  from: '2026-11-03'
                  to: '2026-11-06'
                  engines:
                    - chatgpt
                    - google-ai-overview
                    - perplexity
                  segmentScope: claimed
                  segments:
                    - wms
                  promptScope: category
                  promptsInScope: 2
                  answers: 1
                  subtitle: >-
                    2 prompts in your segments · 1 answers in 4 days · branded
                    prompts reported separately
                  customPromptsExcluded: true
                coverage:
                  reporting:
                    - chatgpt
                  not_reporting: []
                items:
                  - query: 3pl pricing
                    answers: 1
                    prompts: 1
                    engines:
                      - chatgpt
                    is_new: true
                  - query: best 3pl software
                    answers: 1
                    prompts: 1
                    engines:
                      - chatgpt
                    is_new: true
                next_cursor: null
                has_more: false
            text/csv:
              schema:
                type: string
                description: >-
                  With format=csv: one row per item, figures flattened to value,
                  _band, _n and _low_sample columns. The next page is in the
                  Citino-Next-Cursor header.
        '400':
          description: The request is invalid; `error.field` names the parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'No live API key in an `Authorization: Bearer` header.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the scope named in the message, or cannot write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this key's projects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the key's or the workspace's rate limit; see `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Busy or timed out; retry after `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl "https://api.citino.ai/v1/projects/{projectId}/searches" \
              -H "Authorization: Bearer $CITINO_API_KEY"
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            res = requests.get(
                "https://api.citino.ai/v1/projects/{projectId}/searches",
                headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
            )
            print(res.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await
            fetch("https://api.citino.ai/v1/projects/{projectId}/searches", {
              headers: {
                Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
              },
            });

            console.log(await res.json());
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                validation, unauthorized, forbidden, not_found, conflict,
                plan_limit, rate_limited, busy, query_timeout
            message:
              type: string
            field:
              type: string
            detail:
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Workspace settings → API keys, sent as `Authorization:
        Bearer <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.