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

# Retrieve payments stats

> Retrieve payments stats



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /orders/payments/metrics/stats
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: POSAdmin
    description: Admin endpoints to be used as proxy in pos
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /orders/payments/metrics/stats:
    parameters: []
    get:
      tags:
        - Metrics
      summary: Retrieve payments stats
      description: Retrieve payments stats
      operationId: get-payments-metrics
      parameters:
        - name: date_from
          in: query
          description: start datetime
          required: true
          schema:
            type: string
            format: date-time
        - name: date_to
          in: query
          description: end datetime
          required: true
          schema:
            type: string
            format: date-time
        - name: interval
          in: query
          description: for aggregating data
          required: true
          schema:
            type: string
            enum:
              - hour
              - day
              - week
              - month
        - name: user_id
          in: query
          description: 'To retrieve analytics stats of a particular user. '
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      stats:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              format: date-time
                            metrics:
                              $ref: '#/components/schemas/PaymentStats'
                              type: object
                      lifetime_stats:
                        $ref: '#/components/schemas/PaymentStats'
                    type: object
components:
  schemas:
    PaymentStats:
      title: PaymentStats
      type: object
      properties:
        total_payments:
          type: integer
        totaL_payments_value:
          type: number
        total_refunds:
          type: integer
        total_refunds_value:
          type: number
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````