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

# Get performance report

> Returns orders, approved orders, revenue and commission for a period, grouped by day or by affiliate. This endpoint has its own limit of 10 requests per minute. Requires a brand key with scope `whitelabel:reports:read`.

Returns orders, approved orders, revenue and commission for a period, grouped by day or by affiliate. This endpoint has its own limit of **10 requests per minute**. Requires scope `whitelabel:reports:read`.


## OpenAPI

````yaml api-reference/brand/openapi.json GET /brand/whitelabel/reports/performance
openapi: 3.1.0
info:
  title: Lomadee Brand API
  version: 1.0.0
  description: >-
    Read-only REST API for brands. Network and white-label programs have
    separate paths and separate keys.
servers:
  - url: https://api.lomadee.com.br
    description: Production
security:
  - x-api-key: []
tags:
  - name: Network
    description: >-
      Your affiliate program on the Lomadee network. Affiliates are never
      identified; only their channels are.
  - name: White label
    description: Your own white-label affiliate program.
paths:
  /brand/whitelabel/reports/performance:
    get:
      tags:
        - White label
      summary: Get performance report
      description: >-
        Returns orders, approved orders, revenue and commission for a period,
        grouped by day or by affiliate. This endpoint has its own limit of 10
        requests per minute. Requires a brand key with scope
        `whitelabel:reports:read`.
      parameters:
        - name: from
          in: query
          required: true
          description: Start of the period (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: End of the period (ISO 8601). At most 90 days after `from`.
          schema:
            type: string
            format: date-time
        - name: groupBy
          in: query
          required: false
          description: How rows are grouped.
          schema:
            type: string
            enum:
              - day
              - affiliate
            default: day
        - name: page
          in: query
          required: false
          description: Page number.
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          required: false
          description: Items per page. Values above 100 return `400`.
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Report rows
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WhitelabelPerformanceRow'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the window resets.
      schema:
        type: integer
  schemas:
    WhitelabelPerformanceRow:
      type: object
      properties:
        date:
          type:
            - string
            - 'null'
          description: Day (UTC). Present when `groupBy=day`.
          format: date
        affiliate:
          $ref: '#/components/schemas/AffiliateRef'
          description: >-
            Present when `groupBy=affiliate`. `null` for orders without an
            affiliate.
        orders:
          type: integer
          description: Orders created in the period.
        approvedOrders:
          type: integer
          description: Orders with status `approved`.
        revenue:
          type: number
          description: Sum of order totals.
        commission:
          type: number
          description: Sum of commissions.
    Meta:
      type: object
      properties:
        total:
          type: integer
          description: Total items for the filter.
        page:
          type: integer
          description: Current page.
        limit:
          type: integer
          description: Items per page.
        totalPages:
          type: integer
          description: Total pages.
    AffiliateRef:
      type: object
      properties:
        id:
          type: string
          description: Affiliate id in your program.
          format: uuid
        name:
          type: string
          description: Affiliate name.
    Error:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
          description: Human-readable description.
        code:
          type: string
          description: Error code.
          example: FORBIDDEN
      required:
        - success
        - message
        - code
  responses:
    BadRequest:
      description: Invalid parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: limit must not be greater than 100
            code: BAD_REQUEST
    Unauthorized:
      description: >-
        Missing, invalid, expired or revoked key, or a key that is not a brand
        key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid API key
            code: UNAUTHORIZED
    Forbidden:
      description: The key belongs to the other vertical or lacks the scope of the route.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Insufficient scope
            code: FORBIDDEN
    TooManyRequests:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Too many requests
            code: TOO_MANY_REQUESTS
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Brand key created in the dashboard.

````

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