Skip to main content
POST
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.

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.