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

# Store-wide clicks, add-to-carts and orders for a window

> The Analytics funnel's totals for from_date..to_date and the period before it, with attributed revenue and distinct store orders. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /funnel-totals
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:
  /funnel-totals:
    get:
      summary: Store-wide clicks, add-to-carts and orders for a window
      description: >-
        The Analytics funnel's totals for from_date..to_date and the period
        before it, with attributed revenue and distinct store orders. Read-only.
      operationId: funnelTotals
      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
            pattern: ^\d{4}-\d{2}-\d{2}$
            example: '2026-09-01'
            description: First day, inclusive.
          required: true
          description: First day, inclusive.
          name: from_date
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            example: '2026-09-01'
            description: Last day, inclusive.
          required: true
          description: Last day, inclusive.
          name: to_date
          in: query
      responses:
        '200':
          description: The totals, or null for a window with no activity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunnelTotalsResponse'
        '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:
    FunnelTotalsResponse:
      type: object
      properties:
        totals:
          type:
            - object
            - 'null'
          properties:
            clicks:
              type: number
            prev_clicks:
              type: number
            add_to_carts:
              type: number
            prev_add_to_carts:
              type: number
            orders:
              type: number
              description: Units sold (pixel purchases).
            prev_orders:
              type: number
            products:
              type: number
              description: Products with any activity in the window.
            revenue:
              type:
                - number
                - 'null'
              description: >-
                Click-attributed revenue in the shop's currency; null when
                nothing was measured in the window.
            prev_revenue:
              type:
                - number
                - 'null'
            store_orders:
              type: number
              description: Distinct orders from the order feed; absent when unavailable.
            prev_store_orders:
              type: number
          required:
            - clicks
            - prev_clicks
            - add_to_carts
            - prev_add_to_carts
            - orders
            - prev_orders
            - products
          description: null when the window holds no activity.
      required:
        - totals
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
  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.

````