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

# Revenue and sell-through per product in a collection

> Returns, for every product in the collection (0 revenue when it sold nothing), revenue over [from_date, to_date] converted to the merchant's base currency (ECB rates at to_date; an unconvertible currency adds 0), and the sell-through rate. Read-only; answers from Tinybird analytics.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /collections/{collection_id}/product-metrics
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:
  /collections/{collection_id}/product-metrics:
    get:
      summary: Revenue and sell-through per product in a collection
      description: >-
        Returns, for every product in the collection (0 revenue when it sold
        nothing), revenue over [from_date, to_date] converted to the merchant's
        base currency (ECB rates at to_date; an unconvertible currency adds 0),
        and the sell-through rate. Read-only; answers from Tinybird analytics.
      operationId: collectionProductMetrics
      parameters:
        - schema:
            type: string
            description: Numeric Shopify collection id.
          required: true
          description: Numeric Shopify collection id.
          name: collection_id
          in: path
        - 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
        - schema:
            type: string
            description: >-
              Restricts revenue to one Shopify market's countries;
              sell_through_rate is then null.
          required: false
          description: >-
            Restricts revenue to one Shopify market's countries;
            sell_through_rate is then null.
          name: market_id
          in: query
      responses:
        '200':
          description: Metrics by product id.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/CollectionProductMetrics'
        '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:
    CollectionProductMetrics:
      type: object
      properties:
        revenue:
          type: number
        currency:
          type: string
          description: The merchant's base currency (ISO 4217).
        sell_through_rate:
          type:
            - number
            - 'null'
          description: Null when `market_id` is given.
      required:
        - revenue
        - currency
        - sell_through_rate
    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.

````