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
}
'
import requests

url = "https://api.eflow.team/v1/advertisers/dashboard/summary"

payload = { "timezone_id": 67 }
headers = {
"X-Eflow-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({timezone_id: 67})
};

fetch('https://api.eflow.team/v1/advertisers/dashboard/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eflow.team/v1/advertisers/dashboard/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'timezone_id' => 67
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Eflow-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.eflow.team/v1/advertisers/dashboard/summary"

payload := strings.NewReader("{\n \"timezone_id\": 67\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-Eflow-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.eflow.team/v1/advertisers/dashboard/summary")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"timezone_id\": 67\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/advertisers/dashboard/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"timezone_id\": 67\n}"

response = http.request(request)
puts response.read_body
{
  "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.