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

# Get the sales overview

> Revenue, orders, customers and views for today or the last 7 or 30 shop-local days, each with the same elapsed part of the previous period, plus top products. Amounts are in the shop currency.



## OpenAPI

````yaml /openapi.json get /dev/v1/analytics/overview
openapi: 3.0.3
info:
  title: Shoppex Developer API
  description: Mintlify-compatible Developer API reference for Shoppex.
  version: 1.0.0
  contact:
    name: Shoppex Support
    email: support@shoppex.io
    url: https://shoppex.io
servers:
  - url: https://api.shoppex.io
security:
  - bearerAuth: []
paths:
  /dev/v1/analytics/overview:
    get:
      tags:
        - Analytics
      summary: Get the sales overview
      description: >-
        Revenue, orders, customers and views for today or the last 7 or 30
        shop-local days, each with the same elapsed part of the previous period,
        plus top products. Amounts are in the shop currency.
      operationId: getDevV1AnalyticsOverview
      parameters:
        - name: range
          in: query
          required: false
          schema:
            type: string
            enum:
              - today
              - 7d
              - 30d
            description: Shop-local days ending today; default today.
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - range
                      - currency
                      - timezone
                      - kpis
                      - daily
                      - previous_daily
                      - hourly_today
                      - top_products
                    properties:
                      range:
                        type: string
                        enum:
                          - today
                          - 7d
                          - 30d
                      currency:
                        type: string
                      timezone:
                        type: string
                      kpis:
                        type: object
                        required:
                          - revenue
                          - orders
                          - customers
                          - views
                        properties:
                          revenue:
                            type: object
                            required:
                              - value
                              - previous
                              - progress
                            properties:
                              value:
                                type: string
                                description: Decimal amount, for example "12.50".
                              previous:
                                type: string
                                description: Decimal amount, for example "12.50".
                              progress:
                                type: number
                          orders:
                            type: object
                            required:
                              - value
                              - previous
                              - progress
                            properties:
                              value:
                                type: number
                              previous:
                                type: number
                              progress:
                                type: number
                          customers:
                            type: object
                            required:
                              - value
                              - previous
                              - progress
                            properties:
                              value:
                                type: number
                              previous:
                                type: number
                              progress:
                                type: number
                          views:
                            type: object
                            required:
                              - value
                              - previous
                              - progress
                            properties:
                              value:
                                type: number
                              previous:
                                type: number
                              progress:
                                type: number
                      daily:
                        type: array
                        items:
                          type: object
                          required:
                            - period
                            - revenue
                            - orders_count
                          properties:
                            period:
                              type: string
                            revenue:
                              type: string
                              description: Decimal amount, for example "12.50".
                            orders_count:
                              type: number
                      previous_daily:
                        type: array
                        items:
                          type: object
                          required:
                            - period
                            - revenue
                            - orders_count
                          properties:
                            period:
                              type: string
                            revenue:
                              type: string
                              description: Decimal amount, for example "12.50".
                            orders_count:
                              type: number
                      hourly_today:
                        type: array
                        items:
                          type: object
                          required:
                            - period
                            - revenue
                            - orders_count
                          properties:
                            period:
                              type: string
                            revenue:
                              type: string
                              description: Decimal amount, for example "12.50".
                            orders_count:
                              type: number
                      top_products:
                        type: object
                        required:
                          - by_revenue
                          - by_orders
                        properties:
                          by_revenue:
                            type: array
                            items:
                              type: object
                              required:
                                - uniqid
                                - title
                                - revenue
                                - orders
                              properties:
                                uniqid:
                                  type: string
                                  nullable: true
                                title:
                                  type: string
                                  nullable: true
                                revenue:
                                  type: string
                                  description: Decimal amount, for example "12.50".
                                orders:
                                  type: number
                          by_orders:
                            type: array
                            items:
                              type: object
                              required:
                                - uniqid
                                - title
                                - revenue
                                - orders
                              properties:
                                uniqid:
                                  type: string
                                  nullable: true
                                title:
                                  type: string
                                  nullable: true
                                revenue:
                                  type: string
                                  description: Decimal amount, for example "12.50".
                                orders:
                                  type: number
                additionalProperties: true
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '403':
          description: Response for status 403
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '422':
          description: Response for status 422
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
      deprecated: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Use your Shoppex API key in the Authorization header.

````

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