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

# Get Orders Insights

> Returns orders insights.



## OpenAPI

````yaml /api-reference/ops/openapi.json get /api/v1/ops/reports/orders/insights
openapi: 3.0.0
info:
  title: DEVMOB OPS API
  description: DEVMOB API
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: Auth
    description: Authentication and token lifecycle
  - name: Bank Account
    description: Bank accounts
  - name: Benefit
    description: Benefit categories and usage history
  - name: Benefit Program
    description: Fare benefit programs
  - name: Benefit Request
    description: Fare benefit requests and documents
  - name: Credit Grant
    description: Company granted credits
  - name: Driver
    description: Company drivers
  - name: Employee
    description: Company employees
  - name: Employee Session
    description: Employee sessions
  - name: Export
    description: Export resources
  - name: Export Job
    description: Immediate export jobs
  - name: Export Schedule
    description: Scheduled exports
  - name: Invite
    description: Member invitations
  - name: Notification
    description: OPS inbox notifications
  - name: Offering
    description: Trip offerings and seat maps
  - name: Order
    description: Orders
  - name: Organization
    description: Organization profile
  - name: Organization Address
    description: Organization address
  - name: OTP
    description: One-time password flows
  - name: Payment
    description: Payments
  - name: Permission
    description: Permissions
  - name: Point
    description: Point lookup
  - name: Profile
    description: Authenticated OPS profile
  - name: Promotion
    description: Promotions
  - name: Promotion Rule
    description: Promotion rules
  - name: Receivable
    description: Receivables
  - name: Report
    description: Operational reports
  - name: Role
    description: Roles
  - name: Route
    description: Routes
  - name: Route Approval
    description: Route approvals
  - name: Routing
    description: Routing helpers
  - name: Storage
    description: Storage uploads
  - name: Support
    description: Support cases
  - name: Transfer
    description: Transfers
  - name: Trip
    description: Trips
  - name: Trip Event
    description: Trip operational events
  - name: Trip Schedule
    description: Recurring trip schedules
  - name: Trip Tracking
    description: Trip GPS tracking
  - name: Vehicle
    description: Vehicles and seats
paths:
  /api/v1/ops/reports/orders/insights:
    get:
      tags:
        - Report
      summary: Get Orders Insights
      description: Returns orders insights.
      operationId: getOrdersInsights
      parameters:
        - name: amount
          required: false
          in: query
          schema:
            description: Amount range
            example: '>=10;<=50'
            type: string
        - name: createdAt
          required: false
          in: query
          schema:
            description: Created at range
            example: '>=2024-01-01;<=2024-12-31'
            type: string
        - name: filter
          required: false
          in: query
          schema:
            description: |-
              Generic filter that matches against
              - code
              - customer.name
              - customer.email
            example: ORD-123
            type: string
        - name: soldById
          required: false
          in: query
          schema:
            description: Seller user identifier
            type: string
            format: uuid
        - name: type
          required: false
          in: query
          schema:
            description: Order type
            type: string
            enum:
              - POS
              - ONLINE
            example: POS
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderInsights'
          description: OK
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                message: Insufficient permissions
                statusCode: 403
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 403
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
        - bearer: []
components:
  schemas:
    OrderInsights:
      type: object
      properties:
        paid:
          type: integer
          description: Paid count
          example: 48
        pending:
          type: integer
          description: Pending count
          example: 5
        canceled:
          type: integer
          description: Canceled count
          example: 2
        averageValue:
          type: integer
          description: Average paid value in cents
          example: 9000
      required:
        - paid
        - pending
        - canceled
        - averageValue
      additionalProperties: false
      description: Orders insights
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````