Skip to main content
POST
/
networks
/
reporting
/
onhold
/
export
Export On-Hold Conversions
curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/onhold/export \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "from": "2025-01-01",
  "to": "2025-01-31",
  "timezone_id": 67,
  "currency_id": "USD",
  "show_conversions": true,
  "show_events": false,
  "format": "csv",
  "query": {
    "filters": []
  }
}
'
import requests

url = "https://api.eflow.team/v1/networks/reporting/onhold/export"

payload = {
    "from": "2025-01-01",
    "to": "2025-01-31",
    "timezone_id": 67,
    "currency_id": "USD",
    "show_conversions": True,
    "show_events": False,
    "format": "csv",
    "query": { "filters": [] }
}
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({
    from: '2025-01-01',
    to: '2025-01-31',
    timezone_id: 67,
    currency_id: 'USD',
    show_conversions: true,
    show_events: false,
    format: 'csv',
    query: {filters: []}
  })
};

fetch('https://api.eflow.team/v1/networks/reporting/onhold/export', 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/networks/reporting/onhold/export",
  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([
    'from' => '2025-01-01',
    'to' => '2025-01-31',
    'timezone_id' => 67,
    'currency_id' => 'USD',
    'show_conversions' => true,
    'show_events' => false,
    'format' => 'csv',
    'query' => [
        'filters' => [
                
        ]
    ]
  ]),
  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/networks/reporting/onhold/export"

	payload := strings.NewReader("{\n  \"from\": \"2025-01-01\",\n  \"to\": \"2025-01-31\",\n  \"timezone_id\": 67,\n  \"currency_id\": \"USD\",\n  \"show_conversions\": true,\n  \"show_events\": false,\n  \"format\": \"csv\",\n  \"query\": {\n    \"filters\": []\n  }\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/networks/reporting/onhold/export")
  .header("X-Eflow-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": \"2025-01-01\",\n  \"to\": \"2025-01-31\",\n  \"timezone_id\": 67,\n  \"currency_id\": \"USD\",\n  \"show_conversions\": true,\n  \"show_events\": false,\n  \"format\": \"csv\",\n  \"query\": {\n    \"filters\": []\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/networks/reporting/onhold/export")

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  \"from\": \"2025-01-01\",\n  \"to\": \"2025-01-31\",\n  \"timezone_id\": 67,\n  \"currency_id\": \"USD\",\n  \"show_conversions\": true,\n  \"show_events\": false,\n  \"format\": \"csv\",\n  \"query\": {\n    \"filters\": []\n  }\n}"

response = http.request(request)
puts response.read_body
Exports on-hold conversion data in the specified format (CSV or JSON). Accepts the same parameters as the on-hold conversions search endpoint with additional format, columns, and on_hold_status_filter fields. On-hold conversions are pending review before being approved or rejected. The on_hold_status_filter field lets you filter by the on-hold status. The response is a file download with the appropriate Content-Type and Content-Disposition headers set.

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 date range.

​
currency_id
string
required

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

​
format
enum<string>
required

The file format for the export.

Available options:
csv,
json
​
show_conversions
boolean
default:true

Include base conversion records.

​
show_events
boolean
default:false

Include post-conversion event records.

​
show_only_scrub
boolean
default:false

Only include scrubbed conversions/events.

​
show_only_vt
boolean
default:false

Only include view-through conversions.

​
show_only_ct
boolean
default:false

Only include click-through conversions.

​
show_only_fail_traffic
boolean
default:false

Only include fail traffic data.

​
on_hold_status_filter
enum<string>

Filter by on-hold status. Use to show only conversions with a specific on-hold status.

Available options:
on_hold,
approved,
rejected
​
columns
enum<string>[]

Columns to include in the export. If omitted, all columns are included. Same as the conversion export columns with additional on-hold specific columns.

Available options:
offer,
affiliate,
advertiser,
offer_group,
campaign,
affiliate_manager,
creative,
offer_url,
category,
previous_offer,
source_id,
sub1,
sub2,
sub3,
sub4,
sub5,
sub6,
sub7,
sub8,
sub9,
sub10,
adv1,
adv2,
adv3,
adv4,
adv5,
adv6,
adv7,
adv8,
adv9,
adv10,
country,
region,
city,
platform,
os_version,
isp,
account_manager,
android_id,
android_id_md5,
android_id_sha1,
app_id,
brand,
browser,
carrier,
click_date,
conversion_id,
conversion_user_ip,
coupon_code,
currency,
delta_hours,
device,
email,
error_message,
event_name,
google_ad_id,
google_ad_id_md5,
google_ad_id_sha1,
http_user_agent,
idfa,
idfa_md5,
idfa_sha1,
language,
notes,
order_id,
order_line_items,
order_number,
payout,
payout_type,
referrer,
revenue,
revenue_type,
sale_amount,
session_ip,
transaction_id,
type,
conversion_status,
conversion_date,
origin,
network_id,
payout_revenue_id,
project_id,
dma,
is_cookie_based,
previous_transaction_id,
is_event_protected,
is_fired_pixel,
is_scrub,
is_view_through,
attribution_method,
country_code,
on_hold_conversion_id,
holding_period_end,
on_hold_status
​
query
object

Query configuration with filters and search terms. Same structure as the conversion report endpoint.

Response

200

File download. Content-Type is text/csv or application/json depending on the requested format.