Skip to main content
POST
/
affiliates
/
dashboard
/
summary
Dashboard Summary
curl --request POST \
  --url https://api.eflow.team/v1/affiliates/dashboard/summary \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "timezone_id": 67,
  "currency_id": "USD"
}
'
{
  "revenue": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  },
  "click": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  },
  "conversion": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  },
  "cvr": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123
  },
  "events": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  },
  "evr": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123
  },
  "impression": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  },
  "redirect_revenue": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  },
  "on_hold_potential_revenue": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  },
  "on_hold_conversion_count": {
    "today": 123,
    "yesterday": 123,
    "current_month": 123,
    "last_month": 123,
    "trending_percentage": 123
  }
}
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.

Authorizations

X-Eflow-Api-Key
string
header
required

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.

Body

application/json
timezone_id
integer
required

Timezone identifier for the summary calculations.

from
string

Optional start date. Format YYYY-MM-DD.

to
string

Optional end date. Format YYYY-MM-DD.

currency_id
string

Currency code for monetary values (e.g. "USD").

compare_from
string

Optional comparison start date. Format YYYY-MM-DD.

compare_to
string

Optional comparison end date. Format YYYY-MM-DD.

Response

200 - application/json
revenue
object

A dashboard metric with period comparisons and trend.

click
object

A dashboard metric with period comparisons and trend.

conversion
object

A dashboard metric with period comparisons and trend.

cvr
object

A dashboard metric with period comparisons but no trending percentage. Used for rate metrics like CVR and EVR.

events
object

A dashboard metric with period comparisons and trend.

evr
object

A dashboard metric with period comparisons but no trending percentage. Used for rate metrics like CVR and EVR.

impression
object

A dashboard metric with period comparisons and trend.

redirect_revenue
object

A dashboard metric with period comparisons and trend.

on_hold_potential_revenue
object

A dashboard metric with period comparisons and trend.

on_hold_conversion_count
object

A dashboard metric with period comparisons and trend.