> ## 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/bko/openapi.json get /api/v1/bko/reports/orders/insights
openapi: 3.0.0
info:
  title: DEVMOB BKO API
  version: '1.0'
servers: []
security: []
tags:
  - name: Auth
    description: Authentication endpoints.
  - name: Benefit Category
    description: Global fare benefit category endpoints.
  - name: Benefit Program
    description: Platform fare benefit program endpoints.
  - name: Invite
    description: Invitation endpoints.
  - name: Member
    description: BKO internal member endpoints.
  - name: Order
    description: Order query endpoints.
  - name: Organization
    description: Organization management endpoints.
  - name: Organization Address
    description: Organization address endpoints.
  - name: Payment
    description: Payment query endpoints.
  - name: Permission
    description: Permission catalog endpoints.
  - name: Place
    description: Place lookup endpoints.
  - name: Point
    description: Global point catalog endpoints.
  - name: Profile
    description: Authenticated BKO profile endpoints.
  - name: Receivable
    description: Receivable query endpoints.
  - name: Report
    description: Platform report endpoints.
  - name: Role
    description: Internal and reusable role endpoints.
  - name: Storage
    description: Storage upload signing endpoints.
  - name: Transfer
    description: Transfer query endpoints.
  - name: User
    description: Platform user administration endpoints.
paths:
  /api/v1/bko/reports/orders/insights:
    get:
      tags:
        - Report
      summary: Get Orders Insights
      description: Returns orders insights.
      operationId: getOrdersInsights
      parameters:
        - 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
            example: ORD-20260412
            type: string
        - name: organizationId
          required: false
          in: query
          schema:
            description: Organization identifier
            type: string
            format: uuid
        - name: paymentMethod
          required: false
          in: query
          schema:
            type: string
            enum:
              - CASH
              - PIX
              - CREDIT_CARD
              - DEBIT_CARD
            description: Payment method
            example: PIX
        - name: type
          required: false
          in: query
          schema:
            type: string
            enum:
              - POS
              - ONLINE
            description: Order type
            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:
                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
          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:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````