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

# Search totals for the window

> One row per window: searches, users, clicks and the rates. Takes the current and previous windows (from_ts/to_ts, prev_from_ts/prev_to_ts) and answers both, for period-over-period comparison. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /search-reports/summary
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /search-reports/summary:
    get:
      summary: Search totals for the window
      description: >-
        One row per window: searches, users, clicks and the rates. Takes the
        current and previous windows (from_ts/to_ts, prev_from_ts/prev_to_ts)
        and answers both, for period-over-period comparison. Read-only.
      operationId: searchReportSummary
      parameters:
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: query
        - schema:
            type: string
            description: App Bridge session token, when not sent as a bearer header.
          required: false
          description: App Bridge session token, when not sent as a bearer header.
          name: id_token
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            description: Current window start, inclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          required: true
          description: Current window start, inclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          name: from_ts
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            description: Current window end, exclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          required: true
          description: Current window end, exclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          name: to_ts
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            description: Previous window start, inclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          required: true
          description: Previous window start, inclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          name: prev_from_ts
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            description: Previous window end, exclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          required: true
          description: Previous window end, exclusive ("YYYY-MM-DD HH:MM:SS", UTC)
          name: prev_to_ts
          in: query
        - schema:
            type: string
            pattern: ^[A-Za-z_+\-/0-9]{1,64}$
            description: IANA timezone the pipes bucket hours/days in; UTC when omitted.
          required: false
          description: IANA timezone the pipes bucket hours/days in; UTC when omitted.
          name: tz
          in: query
        - schema:
            type: string
            pattern: ^[A-Z0-9]{2}$
            description: Two-letter country code to narrow to.
          required: false
          description: Two-letter country code to narrow to.
          name: country
          in: query
      responses:
        '200':
          description: The report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchReportsSummaryResponse'
        '400':
          description: >-
            The query, path or body failed the schema; `detail` carries zod's
            messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: Merchant not found for this caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    SearchReportsSummaryResponse:
      type: object
      properties:
        current:
          $ref: '#/components/schemas/SearchReportsSummaryRow'
        previous:
          $ref: '#/components/schemas/SearchReportsSummaryRow'
      required:
        - current
        - previous
      description: A window with no traffic is null.
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    SearchReportsSummaryRow:
      type:
        - object
        - 'null'
      properties:
        searches:
          type: number
        no_results:
          type: number
        no_results_rate:
          type: number
        sessions:
          type: number
        users:
          type: number
          description: Unique devices that searched (undercounts across devices).
        clicks:
          type: number
        ctr:
          type: number
        searches_with_click:
          type: number
        no_click_rate:
          type: number
        positioned_searches:
          type: number
        median_click_position:
          type:
            - number
            - 'null'
          description: >-
            Median first position clicked (1 = first) over searches with a
            positioned click; null under the minimum sample.
      required:
        - searches
        - no_results
        - no_results_rate
        - sessions
        - users
        - clicks
        - ctr
        - searches_with_click
        - no_click_rate
        - positioned_searches
        - median_click_position
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Shopify App Bridge session token of the embedded Depict: Search &
        Merchandising app. The shop in the token determines the merchant;
        merchant_id parameters must belong to that shop.

````