Skip to main content
POST
/
advertisers
/
reporting
/
conversions
Search Conversions
curl --request POST \
  --url https://api.eflow.team/v1/advertisers/reporting/conversions \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "show_conversions": true,
  "show_events": false,
  "show_only_vt": false,
  "show_only_ct": false,
  "from": "2024-01-01",
  "to": "2024-01-31",
  "timezone_id": 67,
  "currency_id": "USD",
  "query": {
    "filters": [],
    "search_terms": []
  }
}
'
{
  "conversions": [
    {
      "conversion_id": 123,
      "conversion_unix_timestamp": 123,
      "cost_type": "<string>",
      "cost": 123,
      "sale_amount": 123,
      "ip": "<string>",
      "click_ip": "<string>",
      "user_agent": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "region": "<string>",
      "city": "<string>",
      "dma": 123,
      "carrier": "<string>",
      "platform": "<string>",
      "os_version": "<string>",
      "device_type": "<string>",
      "device_model": "<string>",
      "device_make": "<string>",
      "browser": "<string>",
      "language": "<string>",
      "connection_type": "<string>",
      "isp": "<string>",
      "adv1": "<string>",
      "adv2": "<string>",
      "adv3": "<string>",
      "adv4": "<string>",
      "adv5": "<string>",
      "transaction_id": "<string>",
      "is_event": true,
      "event_name": "<string>",
      "is_view_through": true,
      "is_unique": true,
      "coupon_code": "<string>",
      "time_created": 123,
      "relationship": {
        "offer": {
          "network_offer_id": 123,
          "name": "<string>"
        },
        "affiliate": {
          "network_affiliate_id": 123,
          "name": "<string>"
        }
      }
    }
  ],
  "paging": {
    "page": 123,
    "page_size": 123,
    "total_count": 123
  }
}

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.

Query Parameters

page
integer
default:1

Page number (1-based).

page_size
integer
default:50

Number of results per page.

Body

application/json
show_conversions
boolean
required

Whether to include base conversions in the results.

show_events
boolean
required

Whether to include post-conversion events in the results.

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 (e.g. "USD").

show_only_vt
boolean

When true, only return view-through conversions.

show_only_ct
boolean

When true, only return click-through conversions.

query
object

Query configuration for filtering.

Response

200 - application/json

OK

conversions
object[]

Array of conversion objects.

paging
object