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"
}
'import requests
url = "https://api.eflow.team/v1/affiliates/dashboard/summary"
payload = {
"timezone_id": 67,
"currency_id": "USD"
}
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, currency_id: 'USD'})
};
fetch('https://api.eflow.team/v1/affiliates/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/affiliates/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,
'currency_id' => 'USD'
]),
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/affiliates/dashboard/summary"
payload := strings.NewReader("{\n \"timezone_id\": 67,\n \"currency_id\": \"USD\"\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/affiliates/dashboard/summary")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"timezone_id\": 67,\n \"currency_id\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/affiliates/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 \"currency_id\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
}Get 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"
}
'import requests
url = "https://api.eflow.team/v1/affiliates/dashboard/summary"
payload = {
"timezone_id": 67,
"currency_id": "USD"
}
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, currency_id: 'USD'})
};
fetch('https://api.eflow.team/v1/affiliates/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/affiliates/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,
'currency_id' => 'USD'
]),
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/affiliates/dashboard/summary"
payload := strings.NewReader("{\n \"timezone_id\": 67,\n \"currency_id\": \"USD\"\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/affiliates/dashboard/summary")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"timezone_id\": 67,\n \"currency_id\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/affiliates/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 \"currency_id\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
}Authorizations
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
Timezone identifier for the summary calculations.
Optional start date. Format YYYY-MM-DD.
Optional end date. Format YYYY-MM-DD.
Currency code for monetary values (e.g. "USD").
Optional comparison start date. Format YYYY-MM-DD.
Optional comparison end date. Format YYYY-MM-DD.
Response
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
A dashboard metric with period comparisons but no trending percentage. Used for rate metrics like CVR and EVR.
Show child attributes
Show child attributes
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
A dashboard metric with period comparisons but no trending percentage. Used for rate metrics like CVR and EVR.
Show child attributes
Show child attributes
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
A dashboard metric with period comparisons and trend.
Show child attributes
Show child attributes
Was this page helpful?
