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

# Chat Analytics

> Aggregate KPIs for the AI Chat dashboard.

Window-based — `?window_days=N` controls the lookback. We never run
cross-tenant aggregates here; RLS scopes everything automatically.



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json get /api/v1/admin/chat/analytics
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/chat/analytics:
    get:
      tags:
        - AI
      summary: Chat Analytics
      description: |-
        Aggregate KPIs for the AI Chat dashboard.

        Window-based — `?window_days=N` controls the lookback. We never run
        cross-tenant aggregates here; RLS scopes everything automatically.
      operationId: chat_analytics_api_v1_admin_chat_analytics_get
      parameters:
        - name: window_days
          in: query
          required: false
          schema:
            type: integer
            maximum: 365
            minimum: 1
            default: 30
            title: Window Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_ChatAnalyticsOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ApiResponse_ChatAnalyticsOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/ChatAnalyticsOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[ChatAnalyticsOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChatAnalyticsOut:
      properties:
        window_days:
          type: integer
          title: Window Days
        conversations:
          type: integer
          title: Conversations
        messages:
          type: integer
          title: Messages
        assistant_messages:
          type: integer
          title: Assistant Messages
        refusals:
          type: integer
          title: Refusals
        refusal_rate:
          type: number
          title: Refusal Rate
        total_cost_cents:
          type: integer
          title: Total Cost Cents
        avg_messages_per_conv:
          type: number
          title: Avg Messages Per Conv
        feedback_positive:
          type: integer
          title: Feedback Positive
        feedback_negative:
          type: integer
          title: Feedback Negative
        by_safety:
          additionalProperties:
            type: integer
          type: object
          title: By Safety
        daily_volume:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Daily Volume
      type: object
      required:
        - window_days
        - conversations
        - messages
        - assistant_messages
        - refusals
        - refusal_rate
        - total_cost_cents
        - avg_messages_per_conv
        - feedback_positive
        - feedback_negative
        - by_safety
        - daily_volume
      title: ChatAnalyticsOut
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    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.