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

# Get Overview

> The dashboard's status cards in one call. NOT behind the module gate:
the dashboard is where the operator sees WHY the module is off (no key, ping
failed), so it must answer even when disabled.



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json get /api/v1/admin/nextera/overview
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/nextera/overview:
    get:
      tags:
        - Integrations & modules
      summary: Get Overview
      description: >-
        The dashboard's status cards in one call. NOT behind the module gate:

        the dashboard is where the operator sees WHY the module is off (no key,
        ping

        failed), so it must answer even when disabled.
      operationId: get_overview_api_v1_admin_nextera_overview_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_NexteraOverviewOut_'
      security:
        - HTTPBearer: []
components:
  schemas:
    ApiResponse_NexteraOverviewOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/NexteraOverviewOut'
            - 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[NexteraOverviewOut]
    NexteraOverviewOut:
      properties:
        enabled:
          type: boolean
          title: Enabled
        has_api_key:
          type: boolean
          title: Has Api Key
        last_ping_ok:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Last Ping Ok
        last_ping_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Ping At
        linked_products:
          type: integer
          title: Linked Products
        sync_price_enabled:
          type: boolean
          title: Sync Price Enabled
        sync_stock_enabled:
          type: boolean
          title: Sync Stock Enabled
        sync_interval_minutes:
          type: integer
          title: Sync Interval Minutes
        last_sync_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Sync At
        last_sync_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Sync Status
        next_sync_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Sync At
        fiscal_success:
          type: integer
          title: Fiscal Success
        fiscal_pending:
          type: integer
          title: Fiscal Pending
        fiscal_failed:
          type: integer
          title: Fiscal Failed
        fiscal_cancelled:
          type: integer
          title: Fiscal Cancelled
      type: object
      required:
        - enabled
        - has_api_key
        - linked_products
        - sync_price_enabled
        - sync_stock_enabled
        - sync_interval_minutes
        - fiscal_success
        - fiscal_pending
        - fiscal_failed
        - fiscal_cancelled
      title: NexteraOverviewOut
      description: Everything the Nextera dashboard's status cards need in one call.
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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