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

# List Collection Favourites Endpoint



## OpenAPI

````yaml /api-reference/openapi/foundation-portal.json get /api/v1/merchants/{merchant_id}/collections/favourites
openapi: 3.1.0
info:
  title: Depict Foundation Portal API
  version: 1.0.0
  description: >-
    REST API behind the Depict Foundation merchant portal: merchants, products,
    collections, curation, metrics, analytics and search insights. All endpoints
    require an Auth0-issued bearer token.
servers:
  - url: ''
security: []
paths:
  /api/v1/merchants/{merchant_id}/collections/favourites:
    get:
      tags:
        - Collections
      summary: List Collection Favourites Endpoint
      operationId: >-
        list_collection_favourites_endpoint_api_v1_merchants__merchant_id__collections_favourites_get
      parameters:
        - name: merchant_id
          in: path
          required: true
          schema:
            type: string
            title: Merchant Id
        - name: include_metrics
          in: query
          required: false
          schema:
            type: boolean
            title: Include Metrics
            default: false
        - name: locale
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Locale
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionFavouritesResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - Auth0: []
components:
  schemas:
    CollectionFavouritesResponse:
      properties:
        collections:
          items:
            $ref: '#/components/schemas/CollectionSummary'
          type: array
          title: Collections
      type: object
      required:
        - collections
      title: CollectionFavouritesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CollectionSummary:
      properties:
        collection_id:
          type: string
          format: uuid
          title: Collection Id
        parent_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Parent Id
        collection_type:
          $ref: '#/components/schemas/CollectionType'
        externally_owned:
          type: boolean
          title: Externally Owned
        title:
          type: string
          title: Title
        uri:
          type: string
          title: Uri
        updated_at:
          type: string
          title: Updated At
        n_main_products:
          anyOf:
            - type: integer
            - type: 'null'
          title: N Main Products
        manual_product_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Manual Product Count
        image_urls:
          items:
            type: string
          type: array
          title: Image Urls
          default: []
        cover_image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cover Image Url
        chunk_type:
          anyOf:
            - $ref: '#/components/schemas/ChunkType'
            - type: 'null'
        metrics:
          anyOf:
            - $ref: '#/components/schemas/CollectionMetricsSummary'
            - type: 'null'
      type: object
      required:
        - collection_id
        - collection_type
        - externally_owned
        - title
        - uri
        - updated_at
      title: CollectionSummary
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CollectionType:
      type: string
      enum:
        - long_tail_collection
        - campaign
        - category
        - smart_pick
        - style
        - brand
        - look
      title: CollectionType
    ChunkType:
      type: string
      enum:
        - similar
        - complementary
      title: ChunkType
    CollectionMetricsSummary:
      properties:
        period:
          $ref: '#/components/schemas/CollectionMetricsPeriod'
        total_revenue:
          $ref: '#/components/schemas/CollectionRevenueMetric'
        total_views:
          $ref: '#/components/schemas/CollectionMetricValue'
        total_clicks:
          $ref: '#/components/schemas/CollectionMetricValue'
        avg_ctr:
          $ref: '#/components/schemas/CollectionRateMetric'
        units_sold:
          $ref: '#/components/schemas/CollectionMetricValue'
        avg_str:
          $ref: '#/components/schemas/CollectionRateMetric'
        add_to_carts:
          allOf:
            - $ref: '#/components/schemas/CollectionMetricValue'
          default:
            value: 0
        dead_stock:
          allOf:
            - $ref: '#/components/schemas/CollectionMetricValue'
          default:
            value: 0
        avg_stock_coverage_days:
          anyOf:
            - type: number
            - type: 'null'
          title: Avg Stock Coverage Days
        rpm:
          allOf:
            - $ref: '#/components/schemas/CollectionRevenueMetric'
          default:
            value: 0
            currency: ''
        velocity:
          allOf:
            - $ref: '#/components/schemas/CollectionMetricValue'
          default:
            value: 0
        auto_lift:
          allOf:
            - $ref: '#/components/schemas/CollectionAutoLift'
          default:
            pinned_ctr: 0
            auto_ctr: 0
        top_product:
          anyOf:
            - $ref: '#/components/schemas/CollectionTopProduct'
            - type: 'null'
      type: object
      required:
        - period
        - total_revenue
        - total_views
        - total_clicks
        - avg_ctr
        - units_sold
        - avg_str
      title: CollectionMetricsSummary
    CollectionMetricsPeriod:
      properties:
        start:
          type: string
          format: date
          title: Start
        end:
          type: string
          format: date
          title: End
      type: object
      required:
        - start
        - end
      title: CollectionMetricsPeriod
    CollectionRevenueMetric:
      properties:
        value:
          anyOf:
            - type: number
            - type: 'null'
          title: Value
          default: 0
        currency:
          type: string
          title: Currency
          default: ''
        delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Delta Pct
      type: object
      title: CollectionRevenueMetric
    CollectionMetricValue:
      properties:
        value:
          anyOf:
            - type: number
            - type: 'null'
          title: Value
          default: 0
        delta_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Delta Pct
      type: object
      title: CollectionMetricValue
    CollectionRateMetric:
      properties:
        value:
          type: number
          title: Value
          default: 0
        delta_pts:
          anyOf:
            - type: number
            - type: 'null'
          title: Delta Pts
      type: object
      title: CollectionRateMetric
    CollectionAutoLift:
      properties:
        score:
          anyOf:
            - type: number
            - type: 'null'
          title: Score
        pinned_ctr:
          type: number
          title: Pinned Ctr
          default: 0
        auto_ctr:
          type: number
          title: Auto Ctr
          default: 0
        delta_pts:
          anyOf:
            - type: number
            - type: 'null'
          title: Delta Pts
      type: object
      title: CollectionAutoLift
      description: >-
        Derived "Auto Lift" score: how the click-through rate of auto-sorted

        (non-pinned) products compares to the merchant's manually pinned
        products.


        ``score`` is normalised to 0-100 where ``50`` means auto and pinned
        perform

        equally, ``100`` means auto CTR is >= 2x pinned CTR, and ``0`` means
        auto

        products get no clicks. Computed as ``clamp(50 * auto_ctr / pinned_ctr,
        0,

        100)``. It is ``None`` when the collection has no pinned products or no

        auto (non-pinned) products, so there is nothing to compare.
        ``pinned_ctr``

        and ``auto_ctr`` are percentages (0-100); ``delta_pts`` is

        ``auto_ctr - pinned_ctr`` in percentage points.
    CollectionTopProduct:
      properties:
        main_product_id:
          type: string
          title: Main Product Id
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Image Url
        revenue:
          anyOf:
            - type: number
            - type: 'null'
          title: Revenue
      type: object
      required:
        - main_product_id
      title: CollectionTopProduct
      description: >-
        The highest-revenue product in a collection, for the overview table's

        "Top Product" column. ``image_url`` is the product's first image (or
        None).
  securitySchemes:
    Auth0:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            openid: OpenID Connect
            profile: User profile
            email: User email
          authorizationUrl: https://depict.eu.auth0.com/oauth/authorize
          tokenUrl: https://depict.eu.auth0.com/oauth/token
      x-tokenName: id_token

````