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

# Get Store Analytics

> Retrieve dashboard analytics including revenue, order counts, and visitor stats.



## OpenAPI

````yaml /api-reference/openapi/user-api.yaml get /analytics
openapi: 3.0.3
info:
  title: PapelShip User API
  description: >
    # Introduction

    Welcome to the PapelShip User API. This API allows store owners to
    programmatically manage their store's inventory, orders, and customers.


    # Authentication

    All API requests must be authenticated using your **API Key** and **Store
    Hash**.

    Include these in the request headers:


    | Header | Description |

    | :--- | :--- |

    | `x-api-key` | Your personal API Key found in dashboard settings. |

    | `x-store-hash` | The unique identifier for your store. |
  version: 1.0.0
  contact:
    name: PapelShip Support
    url: https://app.papelship.com/support
    email: support@papelship.com
servers:
  - url: https://app.papelship.com/api_user/api/v1
    description: Production Server
security:
  - ApiKeyAuth: []
    StoreHashAuth: []
tags:
  - name: Analytics
    description: 📊 View store performance, revenue, and visitor statistics.
  - name: Products
    description: 📦 Manage your product inventory, pricing, and details.
  - name: Categories
    description: 📂 Organize products into categories.
  - name: Groups
    description: 📑 Create and manage product groups/collections.
  - name: Coupons
    description: 🎟️ Manage discount codes and promotions.
  - name: Customers
    description: 👥 View customer details and purchase history.
  - name: Invoices
    description: 🧾 Manage orders, process refunds, and view transaction details.
  - name: Reviews
    description: ⭐ Access customer feedback and ratings.
  - name: Checkout
    description: 🛒 Programmatic checkout and order creation.
  - name: Payment Methods
    description: 💳 Configure crypto wallets and payment gateways.
  - name: System
    description: ⚙️ System status and health checks.
paths:
  /analytics:
    get:
      tags:
        - Analytics
      summary: Get Store Analytics
      description: >-
        Retrieve dashboard analytics including revenue, order counts, and
        visitor stats.
      operationId: getAnalytics
      parameters:
        - in: query
          name: from
          schema:
            type: string
            format: date
          description: Start date (YYYY-MM-DD)
        - in: query
          name: to
          schema:
            type: string
            format: date
          description: End date (YYYY-MM-DD)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  analytics:
                    $ref: '#/components/schemas/Analytics'
components:
  schemas:
    Analytics:
      type: object
      properties:
        revenue:
          type: object
          properties:
            cents:
              type: integer
            currency:
              type: string
        orders:
          type: object
          properties:
            total:
              type: integer
            completed:
              type: integer
        customers:
          type: object
          properties:
            total:
              type: integer
        period:
          type: object
          properties:
            from:
              type: string
              nullable: true
            to:
              type: string
              nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your PapelShip API Key
    StoreHashAuth:
      type: apiKey
      in: header
      name: x-store-hash
      description: Your Store Hash ID

````