Affiliate_Connect::getConversions

Gets conversion statistics for the partner

= Required Parameter

Name

Type

Description

limit

Integer

Specifies page size (Integer between 1 and 100)

offset

Integer

Specifies page offset (Integer >= 0)

sort_by

String

Specifies sort fieldShow Supported Values

Any of the following values from the Connect.Conversion model are supported.

= Required Parameter

Name	Description
Brand.network_name	Filter by network name
ConversionsMobile.adv_sub2	Advertiser sub ID 2 specified in the conversion link
ConversionsMobile.adv_sub3	Advertiser sub ID 3 specified in the conversion link
ConversionsMobile.adv_sub4	Advertiser sub ID 4 specified in the conversion link
ConversionsMobile.adv_sub5	Advertiser sub ID 5 specified in the conversion link
ConversionsMobile.affiliate_click_id	Unique click ID used to reference an individual click or session passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique1	Unique value 1 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique2	Unique value 2 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique3	Unique value 3 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique4	Unique value 4 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique5	Unique value 5 passed in by the affiliate when the session started
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.id	ID of the offer
Offer.name	Name of the offer
PayoutGroup.name	Name of payout group used to calculate payout (if applicable); available if network is an Enterprise account.
Stat.ad_id	ID of Transaction object created by the Ad Server
Stat.adv_unique1	Advertiser sub ID 1 specified in the conversion link
Stat.adv_unique2	Advertiser sub ID 2 specified in the conversion link
Stat.adv_unique3	Advertiser sub ID 3 specified in the conversion link
Stat.adv_unique4	Advertiser sub ID 4 specified in the conversion link
Stat.adv_unique5	Advertiser sub ID 5 specified in the conversion link
Stat.advertiser_info	Advertiser sub passed by advertiser on conversion
Stat.affiliate_info1	Affiliate sub 1 passed in by affiliate when session was started
Stat.affiliate_info2	Affiliate sub 2 passed in by affiliate when session was started
Stat.affiliate_info3	Affiliate sub 3 passed in by affiliate when session was started
Stat.affiliate_info4	Affiliate sub 4 passed in by affiliate when session was started
Stat.affiliate_info5	Affiliate sub 5 passed in by affiliate when session was started
Stat.conversion_sale_amount	Sale amount of the conversion; available if network has affiliate Sale Amount enabled.
Stat.conversion_status	Status of the conversion; availability based on network's affiliate Conversion Access preference.
Stat.currency	Currency (3-letter code); available if network has Multiple Currencies enabled.
Stat.datetime	Date and time of the conversion
Stat.modified_datetime	Modification date and time of the conversion
Stat.payout	The amount of payout for approved conversions.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.tune_event_id

Show Supported Values

sort_direction

String

Specifies sort directionShow Supported Values

brand_ids

Array

Filter conversions by given brand_ids.

fields

Array

Specifies which conversion report fields to returnShow Supported Values

Any of the following values from the Connect.Conversion model are supported.

= Required Parameter

Name	Description
Brand.network_name	Filter by network name
ConversionsMobile.adv_sub2	Advertiser sub ID 2 specified in the conversion link
ConversionsMobile.adv_sub3	Advertiser sub ID 3 specified in the conversion link
ConversionsMobile.adv_sub4	Advertiser sub ID 4 specified in the conversion link
ConversionsMobile.adv_sub5	Advertiser sub ID 5 specified in the conversion link
ConversionsMobile.affiliate_click_id	Unique click ID used to reference an individual click or session passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique1	Unique value 1 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique2	Unique value 2 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique3	Unique value 3 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique4	Unique value 4 passed in by the affiliate when the session started
ConversionsMobile.affiliate_unique5	Unique value 5 passed in by the affiliate when the session started
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.id	ID of the offer
Offer.name	Name of the offer
PayoutGroup.name	Name of payout group used to calculate payout (if applicable); available if network is an Enterprise account.
Stat.ad_id	ID of Transaction object created by the Ad Server
Stat.adv_unique1	Advertiser sub ID 1 specified in the conversion link
Stat.adv_unique2	Advertiser sub ID 2 specified in the conversion link
Stat.adv_unique3	Advertiser sub ID 3 specified in the conversion link
Stat.adv_unique4	Advertiser sub ID 4 specified in the conversion link
Stat.adv_unique5	Advertiser sub ID 5 specified in the conversion link
Stat.advertiser_info	Advertiser sub passed by advertiser on conversion
Stat.affiliate_info1	Affiliate sub 1 passed in by affiliate when session was started
Stat.affiliate_info2	Affiliate sub 2 passed in by affiliate when session was started
Stat.affiliate_info3	Affiliate sub 3 passed in by affiliate when session was started
Stat.affiliate_info4	Affiliate sub 4 passed in by affiliate when session was started
Stat.affiliate_info5	Affiliate sub 5 passed in by affiliate when session was started
Stat.conversion_sale_amount	Sale amount of the conversion; available if network has affiliate Sale Amount enabled.
Stat.conversion_status	Status of the conversion; availability based on network's affiliate Conversion Access preference.
Stat.currency	Currency (3-letter code); available if network has Multiple Currencies enabled.
Stat.datetime	Date and time of the conversion
Stat.modified_datetime	Modification date and time of the conversion
Stat.payout	The amount of payout for approved conversions.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.tune_event_id

Show Supported Values

start_date

Date

Start of date range for conversions. Accepts date (2023-01-05) or date with UTC time (2023-01-05T08:15:30-00:00)

end_date

Date

End of date range for conversions. Accepts date (2023-01-05) or date with UTC time (2023-01-05T08:15:30-00:00)

API Call Builder

Javascript is required to use the API Call Builder.