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

# Overview reports

> <Note>With this endpoint you can get an overview across all your campaigns and promoters. Data is updated every `15 minutes`</Note><Tip>**HTTP Request** <br/> `GET https://firstpromoter.com/api/v1/reports/overview` </Tip>



## OpenAPI

````yaml openapi-reports GET /overview
openapi: 3.0.1
info:
  title: FirstPromoter Reports API
  description: >-
    The Reports API allows you to retrieve aggregated data of your affiliate
    performance across 18 data points.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://firstpromoter.com/api/v1/reports
security:
  - apiKeyAuth: []
paths:
  /overview:
    get:
      description: >-
        <Note>With this endpoint you can get an overview across all your
        campaigns and promoters. Data is updated every `15
        minutes`</Note><Tip>**HTTP Request** <br/> `GET
        https://firstpromoter.com/api/v1/reports/overview` </Tip>
      parameters:
        - name: selected_fields[]
          in: query
          description: >-
            An array of fields to return on the response. By default selected
            fields are `revenue_amount`, `clicks_count`, `referrals_count`,
            `customers_count`, `promoter_earnings_amount`.
          schema:
            type: array
            items:
              type: string
              enum:
                - revenue_amount
                - clicks_count
                - referrals_count
                - customers_count
                - active_customers
                - monthly_churn
                - net_revenue_amount
                - sales_count
                - refunds_count
                - cancelled_customers_count
                - promoter_earnings_amount
                - non_link_customers
                - referrals_to_customers_cr
                - 3m_epc
                - 6m_epc
                - clicks_to_customers_cr
                - clicks_to_referrals_cr
                - promoter_paid_amount
          style: form
          explode: true
          allowReserved: true
        - name: sort
          in: query
          description: >-
            Field used for sorting. If not passed, it takes the first field from
            `selected_fields[]`
          schema:
            type: string
            enum:
              - revenue_amount
              - clicks_count
              - referrals_count
              - customers_count
              - active_customers
              - monthly_churn
              - net_revenue_amount
              - sales_count
              - refunds_count
              - cancelled_customers_count
              - promoter_earnings_amount
              - non_link_customers
              - referrals_to_customers_cr
              - 3m_epc
              - 6m_epc
              - clicks_to_customers_cr
              - clicks_to_referrals_cr
              - promoter_paid_amount
        - name: sort_dir
          in: query
          description: Sorting direction. By default is `desc`.
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: group_by
          in: query
          description: >-
            Period to group by. By default is `month`. For day grouping,
            reporting period span is limited at `90 days`
          schema:
            type: string
            enum:
              - day
              - month
              - year
        - name: start_date
          in: query
          description: Beginning of reporting period. Default is set as `12 months ago`
          schema:
            type: string
        - name: end_date
          in: query
          description: End of reporting period. Default is set as `today`
          schema:
            type: string
      responses:
        '200':
          description: Overview report response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Report'
        '401':
          description: Authentication Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
components:
  schemas:
    Report:
      type: object
      properties:
        revenue_amount:
          type: string
          example: $613.17
        clicks_count:
          type: number
          example: 100
        referrals_count:
          type: number
          example: 60
        customers_count:
          type: number
          example: 30
        period:
          type: string
          example: Sep 2024
    AuthenticationError:
      type: string
      example: Bad credentials
    UnprocessableEntity:
      type: object
      properties:
        message:
          type: string
          example: Selected Fields invalid !
        code:
          type: string
          example: invalid_params
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````