Skip to main content
POST
/
networks
/
reporting
/
conversions
/
summary
Get Conversion Summary
curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/conversions/summary \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "from": "2024-01-01",
  "to": "2024-01-31",
  "timezone_id": 67,
  "currency_id": "USD",
  "show_conversions": true,
  "show_events": false
}
'
{
  "total": 123,
  "pending": 123,
  "approved": 123,
  "invalid": 123,
  "rejected_scrub": 123,
  "rejected_manual": 123,
  "payout": 123,
  "revenue": 123,
  "gross_sales": 123,
  "has_multi_currencies": true,
  "avg_click_to_cv_time": 123
}

Authorizations

​
X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Body

application/json
​
from
string
required

Start date. Format YYYY-MM-DD or YYYY-MM-DD HH:mm:SS.

​
to
string
required

End date. Format YYYY-MM-DD or YYYY-MM-DD HH:mm:SS.

​
timezone_id
integer
required

Timezone identifier for the request.

​
currency_id
string
required

Currency code for monetary values. Currently only USD is supported.

​
show_conversions
boolean

Include base conversions in the summary. At least one of show_conversions or show_events must be true.

​
show_events
boolean

Include post-conversion events in the summary. At least one of show_conversions or show_events must be true.

​
show_only_scrub
boolean

When true, only include scrubbed conversions/events in the summary.

​
query
object

Optional query filters to narrow the summary scope.

Response

200 - application/json

OK

​
total
integer

Total number of conversions/events matching the query.

​
pending
integer

Number of conversions/events with pending status.

​
approved
integer

Number of approved conversions/events.

​
invalid
integer

Number of invalid conversions/events.

​
rejected_scrub
integer

Number of conversions/events rejected by scrub rules.

​
rejected_manual
integer

Number of manually rejected conversions/events.

​
payout
number<double>

Total payout amount.

​
revenue
number<double>

Total revenue amount.

​
gross_sales
number<double>

Total gross sales amount.

​
has_multi_currencies
boolean

Indicates whether the result set includes conversions in multiple currencies.

​
avg_click_to_cv_time
number<double>

Average time in seconds between the click and the conversion.