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

Authorizations

​
X-Eflow-Api-Key
string
header
required

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.

Body

application/json
​
timezone_id
integer
required

Timezone identifier for computing period boundaries.

​
from
string

Start date for the reporting period. Format YYYY-MM-DD.

​
to
string

End date for the reporting period. Format YYYY-MM-DD.

​
currency_id
string

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

​
compare_from
string

Start date for the comparison period. Format YYYY-MM-DD.

​
compare_to
string

End date for the comparison period. Format YYYY-MM-DD.

Response

200 - application/json
​
click
object

A dashboard metric with period comparisons and trending data.

​
conversion
object

A dashboard metric with period comparisons and trending data.

​
cost
object

A dashboard metric with period comparisons and trending data.

​
cvr
object

A dashboard metric with period comparisons but no trending percentage (used for CVR).

​
events
object

A dashboard metric with period comparisons and trending data.

​
evr
object

A dashboard metric with period comparisons and trending data.

​
imp
object

A dashboard metric with period comparisons and trending data.

​
gross_sales
object

A dashboard metric with period comparisons and trending data.