openapi: 3.0.3
info:
  title: Everflow Network API - Dashboard Reporting
  description: >
    Dashboard summary endpoint for the Everflow partner marketing platform.
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
tags:
  - name: Reporting
    description: Dashboard reporting endpoint.
paths:
  /networks/dashboard/summary:
    get:
      summary: Get Dashboard Summary
      tags:
        - Reporting
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  revenue:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  payout:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  profit:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  click:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  conversion:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  event:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  gross_sales:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  gross_click:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  impression:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  invalid_click:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  duplicate_click:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  unique_click:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  view_through_conversion:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  approved_conversion:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  throttled_conversion:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  margin:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  cvr:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  evr:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  cpc:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  epc:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  rpc:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  rpm:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  cpm:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  ctr:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                    type: object
                  total_conversion:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  on_hold_potential_revenue:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  on_hold_potential_payout:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                  on_hold_conversion_count:
                    properties:
                      today:
                        type: number
                      yesterday:
                        type: number
                      current_month:
                        type: number
                      last_month:
                        type: number
                      trending_percentage:
                        type: number
                    type: object
                type: object
          description: ""
      security:
        - API Key: []
components:
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey