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

# Get Dashboard Summary

Returns a high-level dashboard summary of the affiliate's performance metrics. Provides today, yesterday, current month, last month values and trending percentages for key metrics including revenue, clicks, conversions, CVR, events, EVR, and impressions.


## OpenAPI

````yaml openapi/affiliate-reporting.yaml post /affiliates/dashboard/summary
openapi: 3.0.3
info:
  title: Everflow Affiliate API - Reporting
  description: >
    Reporting endpoints for the Everflow Affiliate API. These endpoints are
    accessed by affiliate/partner users using their own API key and return data
    scoped to the authenticated affiliate's account only. For more detail, see
    [Essential Reports For New
    Partners](https://helpdesk.everflow.io/collaborator/essential-reports-for-new-partners)
    in the Help Center.
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
security: []
tags:
  - name: Affiliate Reporting
    description: Reporting endpoints available to affiliate users.
paths:
  /affiliates/dashboard/summary:
    post:
      tags:
        - Affiliate Reporting
      summary: Dashboard Summary
      requestBody:
        required: true
        content:
          application/json:
            example:
              timezone_id: 67
              currency_id: USD
            schema:
              type: object
              required:
                - timezone_id
              properties:
                timezone_id:
                  type: integer
                  description: Timezone identifier for the summary calculations.
                from:
                  type: string
                  description: Optional start date. Format `YYYY-MM-DD`.
                to:
                  type: string
                  description: Optional end date. Format `YYYY-MM-DD`.
                currency_id:
                  type: string
                  description: Currency code for monetary values (e.g. "USD").
                compare_from:
                  type: string
                  description: Optional comparison start date. Format `YYYY-MM-DD`.
                compare_to:
                  type: string
                  description: Optional comparison end date. Format `YYYY-MM-DD`.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  revenue:
                    $ref: '#/components/schemas/DashboardMetric'
                  click:
                    $ref: '#/components/schemas/DashboardMetric'
                  conversion:
                    $ref: '#/components/schemas/DashboardMetric'
                  cvr:
                    $ref: '#/components/schemas/DashboardMetricNoTrend'
                  events:
                    $ref: '#/components/schemas/DashboardMetric'
                  evr:
                    $ref: '#/components/schemas/DashboardMetricNoTrend'
                  impression:
                    $ref: '#/components/schemas/DashboardMetric'
                  redirect_revenue:
                    $ref: '#/components/schemas/DashboardMetric'
                  on_hold_potential_revenue:
                    $ref: '#/components/schemas/DashboardMetric'
                  on_hold_conversion_count:
                    $ref: '#/components/schemas/DashboardMetric'
      security:
        - API Key: []
components:
  schemas:
    DashboardMetric:
      type: object
      description: A dashboard metric with period comparisons and trend.
      properties:
        today:
          type: number
          description: Value for today.
        yesterday:
          type: number
          description: Value for yesterday.
        current_month:
          type: number
          description: Value for the current month to date.
        last_month:
          type: number
          description: Value for the previous month.
        trending_percentage:
          type: number
          description: Percentage change indicating the trend direction.
    DashboardMetricNoTrend:
      type: object
      description: >
        A dashboard metric with period comparisons but no trending percentage.
        Used for rate metrics like CVR and EVR.
      properties:
        today:
          type: number
          description: Value for today.
        yesterday:
          type: number
          description: Value for yesterday.
        current_month:
          type: number
          description: Value for the current month to date.
        last_month:
          type: number
          description: Value for the previous month.
  securitySchemes:
    API Key:
      description: >
        The affiliate's API key generated from the Affiliate Portal. Uses the
        same X-Eflow-Api-Key header as the Network API, but the key belongs to
        the affiliate user rather than the network admin.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````