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

# Generate a partner report

> Returns an aggregated report for the authenticated partner over the requested date range, grouped and aggregated as specified. The response Content-Type is selected via the `Accept` request header (`application/json` default; `text/csv` for CSV).



## OpenAPI

````yaml /playbackapi/openapi.json post /v1/partners/reports
openapi: 3.0.0
info:
  title: Playback Partner API
  description: ''
  version: '1.0'
  contact: {}
servers:
  - url: https://api.playbackdirect.com
security: []
tags: []
paths:
  /v1/partners/reports:
    post:
      tags:
        - Partners
      summary: Generate a partner report
      description: >-
        Returns an aggregated report for the authenticated partner over the
        requested date range, grouped and aggregated as specified. The response
        Content-Type is selected via the `Accept` request header
        (`application/json` default; `text/csv` for CSV).
      operationId: PartnerReportsApiController_generateReport
      parameters:
        - name: Accept
          in: header
          description: '`application/json` (default) or `text/csv`'
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerReportRequestDto'
      responses:
        '200':
          description: Report rows in the requested format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerReportResponseDto'
            text/csv:
              schema:
                type: string
        '400':
          description: Invalid request body or parameters.
        '401':
          description: Missing or invalid partner API token.
        '429':
          description: Rate limit exceeded.
      security:
        - bearer: []
components:
  schemas:
    PartnerReportRequestDto:
      type: object
      properties:
        from:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
          example: '2026-01-01'
        to:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
          example: '2026-01-02'
        query:
          type: object
          properties:
            group:
              type: array
              minItems: 1
              items:
                type: string
                enum:
                  - offerId
                  - day
              example:
                - offerId
                - day
            columns:
              type: array
              minItems: 1
              items:
                type: string
                enum:
                  - clicks
                  - installs
                  - purchases
                  - revenue
                  - advertiser_revenue
                  - day_1_retention
                  - day_3_retention
                  - day_7_retention
                  - day_14_retention
                  - day_30_retention
                  - day_1_roas
                  - day_3_roas
                  - day_7_roas
                  - day_14_roas
                  - day_30_roas
              example: installs
          required:
            - group
            - columns
      required:
        - from
        - to
        - query
    PartnerReportResponseDto:
      type: object
      properties:
        report:
          type: array
          items:
            type: object
            additionalProperties:
              oneOf:
                - type: string
                - type: number
          example:
            - offerId: MMLmUFaHwzOSW9vAphQu
              day: '2026-01-01'
              installs: 5
            - offerId: MMLmUFaHwzOSW9vAphQu
              day: '2026-01-02'
              installs: 6
      required:
        - report
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: Partner Token
      type: http

````