> ## 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

Retrieve high-level dashboard metrics comparing current performance against previous periods. Returns clicks, conversions, cost, conversion rate, events, event rate, and impressions — each with today, yesterday, current month, and last month values plus trending percentages.


## OpenAPI

````yaml openapi/advertiser-reporting.yaml post /advertisers/dashboard/summary
openapi: 3.0.3
info:
  title: Everflow Advertiser API - Reporting
  description: >
    Reporting endpoints for the Everflow Advertiser API. These endpoints are
    accessed by advertiser users using their own API key and return data scoped
    to the authenticated advertiser's account only.
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
security: []
tags:
  - name: Advertiser Reporting
    description: Reporting endpoints available to advertiser users.
paths:
  /advertisers/dashboard/summary:
    post:
      tags:
        - Advertiser Reporting
      summary: Dashboard Summary
      requestBody:
        required: true
        content:
          application/json:
            example:
              timezone_id: 67
            schema:
              type: object
              required:
                - timezone_id
              properties:
                timezone_id:
                  type: integer
                  description: Timezone identifier for computing period boundaries.
                from:
                  type: string
                  description: Start date for the reporting period. Format `YYYY-MM-DD`.
                to:
                  type: string
                  description: End date for the reporting period. Format `YYYY-MM-DD`.
                currency_id:
                  type: string
                  description: Currency code for monetary values (e.g. "USD").
                compare_from:
                  type: string
                  description: Start date for the comparison period. Format `YYYY-MM-DD`.
                compare_to:
                  type: string
                  description: End date for the comparison period. Format `YYYY-MM-DD`.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  click:
                    $ref: '#/components/schemas/DashboardMetric'
                  conversion:
                    $ref: '#/components/schemas/DashboardMetric'
                  cost:
                    $ref: '#/components/schemas/DashboardMetric'
                  cvr:
                    $ref: '#/components/schemas/DashboardMetricNoTrend'
                  events:
                    $ref: '#/components/schemas/DashboardMetric'
                  evr:
                    $ref: '#/components/schemas/DashboardMetric'
                  imp:
                    $ref: '#/components/schemas/DashboardMetric'
                  gross_sales:
                    $ref: '#/components/schemas/DashboardMetric'
      security:
        - API Key: []
components:
  schemas:
    DashboardMetric:
      type: object
      description: A dashboard metric with period comparisons and trending data.
      properties:
        current_month:
          type: number
          description: Value for the current month to date.
        last_month:
          type: number
          description: Value for the entire previous month.
        today:
          type: number
          description: Value for the current day so far.
        yesterday:
          type: number
          description: Value for the full previous day.
        trending_percentage:
          type: number
          description: Month-over-month trending percentage.
    DashboardMetricNoTrend:
      type: object
      description: >-
        A dashboard metric with period comparisons but no trending percentage
        (used for CVR).
      properties:
        current_month:
          type: number
          description: Value for the current month to date.
        last_month:
          type: number
          description: Value for the entire previous month.
        today:
          type: number
          description: Value for the current day so far.
        yesterday:
          type: number
          description: Value for the full previous day.
  securitySchemes:
    API Key:
      description: >
        The advertiser's API key generated from the Advertiser Portal. Uses the
        same X-Eflow-Api-Key header as other Everflow APIs, but the key belongs
        to the advertiser user rather than the network admin.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````