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

# Breakdown Report

> Una scomposizione per stato, prodotto o metodo di pagamento
(docs/PIANO_DASHBOARD.md §6.4). Solo con ``reports``.



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json get /api/v1/admin/analytics/breakdown/{dimension}
openapi: 3.1.0
info:
  title: Vellaro Admin API
  description: >-
    Store management under `/api/v1/admin`, for back ends and integrations.
    Every call takes `Authorization: Bearer <token>`: an admin API token or a
    staff user's token. The permissions of its role decide what it can do,
    always in its own store.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Orders
    description: >-
      Orders and manual orders, payments, refunds, shipments, invoices, returns,
      customer subscriptions.
  - name: Products
    description: Products, variants, images, prices and discounts, product lookups.
  - name: Categories & catalog setup
    description: >-
      Categories, brands, attributes, options, filters, downloadable files,
      recurring profiles.
  - name: Inventory
    description: Stock of the variants and stock statuses.
  - name: Customers
    description: Customers, customer groups, custom fields.
  - name: Reviews & questions
    description: Moderation of product reviews and questions.
  - name: Promotions & coupons
    description: Coupons and gift vouchers.
  - name: Marketing
    description: Campaigns, newsletter subscribers, affiliates and their commissions.
  - name: Content
    description: >-
      CMS pages, menus, banners, information pages, flipbooks, media library,
      SEO URLs, email templates, translations.
  - name: Settings
    description: >-
      Store settings, email delivery, languages, currencies, physical stores,
      social login providers.
  - name: Shipping
    description: Couriers, shipping rates, weight and length classes.
  - name: Taxes & geo
    description: Tax classes, rates and rules; countries, zones and geo zones.
  - name: Integrations & modules
    description: >-
      Integrations, plugins and modules (Iute, extra warranty, Nextera, Financa
      5, WhatsApp, Firebase), outbound webhooks.
  - name: AI
    description: AI content generation and the settings of the AI shopping assistant.
  - name: Imports
    description: 'CSV imports and the universal import: runs, mappings, previews, undo.'
  - name: Reports & dashboard
    description: Dashboard figures and reports.
  - name: Users & API keys
    description: Staff users and roles, publishable keys, admin API tokens.
  - name: Audit
    description: The store's audit log.
paths:
  /api/v1/admin/analytics/breakdown/{dimension}:
    get:
      tags:
        - Reports & dashboard
      summary: Breakdown Report
      description: |-
        Una scomposizione per stato, prodotto o metodo di pagamento
        (docs/PIANO_DASHBOARD.md §6.4). Solo con ``reports``.
      operationId: breakdown_report_api_v1_admin_analytics_breakdown__dimension__get
      parameters:
        - name: dimension
          in: path
          required: true
          schema:
            type: string
            title: Dimension
        - name: period
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 32
              - type: 'null'
            title: Period
        - name: month
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 16
              - type: 'null'
            title: Month
        - name: quarter
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 16
              - type: 'null'
            title: Quarter
        - name: year
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 8
              - type: 'null'
            title: Year
        - name: from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 16
              - type: 'null'
            title: From
        - name: to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 16
              - type: 'null'
            title: To
        - name: compare
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 16
              - type: 'null'
            title: Compare
        - name: metric
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^(sales|orders|units)$
              - type: 'null'
            title: Metric
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 8
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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