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

# Monthly goal widget (percent only)



## OpenAPI

````yaml /openapi.en.json get /api/v2/storefront/v1/shops/{shopId}/widgets/monthly-goal
openapi: 3.0.0
info:
  title: ItemShop v2 API
  description: >-
    REST API platformy ItemShop v2 (NestJS + Fastify). Wszystkie ścieżki mają
    prefiks /api/v2.
  version: 2.0.0
  contact: {}
servers:
  - url: https://itemshop.dev
    description: Production (API under /api/v2, same origin as the panel)
  - url: http://localhost:3000
    description: Local
security: []
tags: []
paths:
  /api/v2/storefront/v1/shops/{shopId}/widgets/monthly-goal:
    get:
      tags:
        - Storefront v1
      summary: Monthly goal widget (percent only)
      operationId: getMonthlyGoal
      parameters:
        - name: shopId
          required: true
          in: path
          description: >-
            Shop ID (ObjectId). Also accepts the `uniqueName`, an active custom
            domain or `<uniqueName>.<hosting domain>`.
          schema:
            type: string
            example: 664f1a2b3c4d5e6f7a8b9c0d
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontMonthlyGoalResponseDto'
        '403':
          description: Origin outside the shop domains (`ORIGIN_NOT_ALLOWED`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontErrorDto'
        '404':
          description: >-
            Shop/resource not found or the shop is blocked (`SHOP_NOT_FOUND`,
            `PRODUCT_NOT_FOUND`, `ORDER_NOT_FOUND`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontErrorDto'
        '429':
          description: Rate limit exceeded (`RATE_LIMITED`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontErrorDto'
components:
  schemas:
    StorefrontMonthlyGoalResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/StorefrontMonthlyGoalDto'
      required:
        - success
        - data
    StorefrontErrorDto:
      type: object
      properties:
        success:
          type: boolean
          example: false
        statusCode:
          type: number
          example: 404
        code:
          enum:
            - VALIDATION_FAILED
            - BAD_REQUEST
            - NOT_FOUND
            - SHOP_NOT_FOUND
            - PRODUCT_NOT_FOUND
            - ORDER_NOT_FOUND
            - PRODUCT_UNAVAILABLE
            - PRODUCT_VARIANT_REQUIRED
            - INVALID_PRODUCT_VARIANT
            - INVALID_QUANTITY
            - OUT_OF_STOCK
            - CART_EMPTY
            - NICK_REQUIRED
            - EMAIL_REQUIRED
            - CART_TOO_LARGE
            - DISCOUNT_INVALID
            - LEGAL_CONSENT_REQUIRED
            - LEGAL_DOCUMENTS_CHANGED
            - SHOP_PAYMENT_NOT_READY
            - PAYMENT_INIT_FAILED
            - ORDER_BLOCKED
            - RETURN_URL_NOT_ALLOWED
            - VOUCHER_NOT_FOUND
            - VOUCHER_USED
            - VOUCHER_EXPIRED
            - IDEMPOTENCY_KEY_REQUIRED
            - IDEMPOTENCY_KEY_REUSED
            - CHECKOUT_ATTEMPT_CLOSED
            - CHECKOUT_IN_PROGRESS
            - CAPTCHA_REQUIRED
            - ORIGIN_NOT_ALLOWED
            - FORBIDDEN
            - UNAUTHORIZED
            - PAYLOAD_TOO_LARGE
            - CONFLICT
            - RATE_LIMITED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
          type: string
          description: Machine-readable error code — translate UI messages by this
          example: SHOP_NOT_FOUND
        message:
          type: string
          description: >-
            Developer message (language not guaranteed; do not show it to
            buyers)
          example: Shop not found
        error:
          type: string
          description: Same as `message` (compatibility with the rest of the API)
          example: Shop not found
          deprecated: true
        details:
          type: object
          description: Validation details
        timestamp:
          type: string
          format: date-time
          example: '2026-10-27T12:00:00.000Z'
        path:
          type: string
          example: /api/v2/storefront/v1/shops/moj-sklep
      required:
        - success
        - statusCode
        - code
        - message
        - error
        - timestamp
        - path
    StorefrontMonthlyGoalDto:
      type: object
      properties:
        enabled:
          type: boolean
          description: Also false when the owner hid the goal (`publicData.monthlyGoal`)
          example: true
        percent:
          type: number
          description: Progress 0–100 (amounts are not public)
          example: 64
      required:
        - enabled
        - percent

````

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