Affiliate_Report::getConversions

Get conversion report.

= Required Parameter

Name

Type

Description

fields

Array

List of fields to returnShow Supported Values

Any of the following values from the ConversionReport model are supported.

Name	Description
Browser.display_name	Name of the Browser
Browser.id	ID of the web browser. If a browser was not identified, defaults to "0".
ConversionMeta.note	A note
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
ConversionsMobile.device_brand	(Mobile) Device Brand; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_model	(Mobile) Device Model; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_os	(Mobile) Device OS; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_os_version	(Mobile) Device OS Version; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.google_aid	(Mobile) Google AID; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.google_aid_md5	(Mobile) Google AID MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.google_aid_sha1	(Mobile) Google AID SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa	(Mobile) iOS IFA; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa_md5	(Mobile) iOS IFA MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa_sha1	(Mobile) iOS IFA SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.mobile_carrier	(Mobile) Carrier; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.unknown_id	ID of (Mobile) Unknown object; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid	(Mobile) Windows AID; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid_md5	(Mobile) Windows AID MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid_sha1	(Mobile) Windows AID SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
Country.name	The name of the Country
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.name	Name of the offer this conversion is for
OfferUrl.id	ID of the offer URL
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
PayoutGroup.id	ID of payout group used to calculate payout (if applicable); available if network is an Enterprise account.
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.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.approved_payout	The amount of payout for approved conversions. If a single conversion, this is the same as "Stat.payout", but if aggregating this is the sum of the payouts of the approved Conversions.
Stat.conversion_status	Status of the conversion; availability based on network's affiliate Conversion Access preference.
Stat.count_approved	Aggregate counting function that returns the number of Conversions whose status is "approved" in the row
Stat.currency	Currency (3-letter code); available if network has Multiple Currencies enabled.
Stat.date	Date (YYYY-MM-DD) part of "Stat.datetime".
Stat.datetime	Date and time of the conversion
Stat.goal_id	ID of the goal this conversion is for. If no goal is applicable, default to "0"; available if network has Offer Goals enabled.
Stat.hour	Hour part (0 to 23) from "Stat.datetime".
Stat.id	ID of unique object for the conversion
Stat.ip	IP address that created the conversion. Limits response data to last 120 days if included.
Stat.is_adjustment	Flag to mark if the conversion was created as an adjustment
Stat.month	Month part (1 to 12) from "Stat.datetime".
Stat.offer_id	The ID of the Offer this conversion is for
Stat.offer_url_id	The ID of the Offer URL. If none is set, defaults to "0".
Stat.pixel_refer	Referral URL for the conversion pixel
Stat.refer	Referral URL where session was started
Stat.sale_amount	Sale amount of the conversion; available if network has affiliate Sale Amount enabled.
Stat.session_datetime	Date and time that the session was started
Stat.session_ip	IP address used to start the session. Limits response data to last 120 days if included.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.user_agent	User agent for user when session was started
Stat.week	The week in which "Stat.datetime" took place. Range is 1 to 53, where week 1 is the first week with four (4) or more days. Weeks begin on Monday.
Stat.year	Year part (YYYY) from "Stat.datetime".

Show Supported Values

filters

Filter

Array of field values to filter results byShow Filterable Fields

The following fields from the model can be filtered on.

Name	Description
Browser.display_name	Name of the Browser
Browser.id	ID of the web browser. If a browser was not identified, defaults to "0".
ConversionMeta.note	A note
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
ConversionsMobile.device_brand	(Mobile) Device Brand; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_model	(Mobile) Device Model; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_os	(Mobile) Device OS; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_os_version	(Mobile) Device OS Version; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.google_aid	(Mobile) Google AID; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.google_aid_md5	(Mobile) Google AID MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.google_aid_sha1	(Mobile) Google AID SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa	(Mobile) iOS IFA; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa_md5	(Mobile) iOS IFA MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa_sha1	(Mobile) iOS IFA SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.mobile_carrier	(Mobile) Carrier; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.unknown_id	ID of (Mobile) Unknown object; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid	(Mobile) Windows AID; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid_md5	(Mobile) Windows AID MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid_sha1	(Mobile) Windows AID SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
Country.name	The name of the Country
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.name	Name of the offer this conversion is for
OfferUrl.id	ID of the offer URL
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
PayoutGroup.id	ID of payout group used to calculate payout (if applicable); available if network is an Enterprise account.
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.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.approved_payout	The amount of payout for approved conversions. If a single conversion, this is the same as "Stat.payout", but if aggregating this is the sum of the payouts of the approved Conversions.
Stat.conversion_status	Status of the conversion; availability based on network's affiliate Conversion Access preference.
Stat.count_approved	Aggregate counting function that returns the number of Conversions whose status is "approved" in the row
Stat.currency	Currency (3-letter code); available if network has Multiple Currencies enabled.
Stat.date	Date (YYYY-MM-DD) part of "Stat.datetime".
Stat.datetime	Date and time of the conversion
Stat.goal_id	ID of the goal this conversion is for. If no goal is applicable, default to "0"; available if network has Offer Goals enabled.
Stat.hour	Hour part (0 to 23) from "Stat.datetime".
Stat.id	ID of unique object for the conversion
Stat.ip	IP address that created the conversion. Limits response data to last 120 days if included.
Stat.is_adjustment	Flag to mark if the conversion was created as an adjustment
Stat.month	Month part (1 to 12) from "Stat.datetime".
Stat.offer_id	The ID of the Offer this conversion is for
Stat.offer_url_id	The ID of the Offer URL. If none is set, defaults to "0".
Stat.pixel_refer	Referral URL for the conversion pixel
Stat.refer	Referral URL where session was started
Stat.sale_amount	Sale amount of the conversion; available if network has affiliate Sale Amount enabled.
Stat.session_datetime	Date and time that the session was started
Stat.session_ip	IP address used to start the session. Limits response data to last 120 days if included.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.user_agent	User agent for user when session was started
Stat.week	The week in which "Stat.datetime" took place. Range is 1 to 53, where week 1 is the first week with four (4) or more days. Weeks begin on Monday.
Stat.year	Year part (YYYY) from "Stat.datetime".

Show Filterable Fields

sort

Sort

Array of fields and directions to sort results byShow Sortable Fields

The following fields from the model can be sorted in either ascending (ASC) or descending (DESC) order.

Name	Description
Browser.display_name	Name of the Browser
Browser.id	ID of the web browser. If a browser was not identified, defaults to "0".
ConversionMeta.note	A note
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
ConversionsMobile.device_brand	(Mobile) Device Brand; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_model	(Mobile) Device Model; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_os	(Mobile) Device OS; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.device_os_version	(Mobile) Device OS Version; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.google_aid	(Mobile) Google AID; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.google_aid_md5	(Mobile) Google AID MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.google_aid_sha1	(Mobile) Google AID SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa	(Mobile) iOS IFA; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa_md5	(Mobile) iOS IFA MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.ios_ifa_sha1	(Mobile) iOS IFA SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.mobile_carrier	(Mobile) Carrier; available if network has Show Mobile Tracking Parameters enabled.
ConversionsMobile.unknown_id	ID of (Mobile) Unknown object; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid	(Mobile) Windows AID; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid_md5	(Mobile) Windows AID MD5; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
ConversionsMobile.windows_aid_sha1	(Mobile) Windows AID SHA1; available if network has Show Mobile Tracking Parameters enabled. Limits response data to last 120 days if included.
Country.name	The name of the Country
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.name	Name of the offer this conversion is for
OfferUrl.id	ID of the offer URL
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
PayoutGroup.id	ID of payout group used to calculate payout (if applicable); available if network is an Enterprise account.
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.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.approved_payout	The amount of payout for approved conversions. If a single conversion, this is the same as "Stat.payout", but if aggregating this is the sum of the payouts of the approved Conversions.
Stat.conversion_status	Status of the conversion; availability based on network's affiliate Conversion Access preference.
Stat.count_approved	Aggregate counting function that returns the number of Conversions whose status is "approved" in the row
Stat.currency	Currency (3-letter code); available if network has Multiple Currencies enabled.
Stat.date	Date (YYYY-MM-DD) part of "Stat.datetime".
Stat.datetime	Date and time of the conversion
Stat.goal_id	ID of the goal this conversion is for. If no goal is applicable, default to "0"; available if network has Offer Goals enabled.
Stat.hour	Hour part (0 to 23) from "Stat.datetime".
Stat.id	ID of unique object for the conversion
Stat.ip	IP address that created the conversion. Limits response data to last 120 days if included.
Stat.is_adjustment	Flag to mark if the conversion was created as an adjustment
Stat.month	Month part (1 to 12) from "Stat.datetime".
Stat.offer_id	The ID of the Offer this conversion is for
Stat.offer_url_id	The ID of the Offer URL. If none is set, defaults to "0".
Stat.pixel_refer	Referral URL for the conversion pixel
Stat.refer	Referral URL where session was started
Stat.sale_amount	Sale amount of the conversion; available if network has affiliate Sale Amount enabled.
Stat.session_datetime	Date and time that the session was started
Stat.session_ip	IP address used to start the session. Limits response data to last 120 days if included.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.user_agent	User agent for user when session was started
Stat.week	The week in which "Stat.datetime" took place. Range is 1 to 53, where week 1 is the first week with four (4) or more days. Weeks begin on Monday.
Stat.year	Year part (YYYY) from "Stat.datetime".

Show Sortable Fields

limit

Integer

Objects per page to return; defaults to returning all found

page

Integer

Result page to return, based on limit value; defaults to 1

totals

Boolean

Get totals on aggregate fields

data_start

Date

Start of date range for time zone shifting; use "YYYY-MM-DD" format

data_end

Date

End of date range for time zone shifting; use "YYYY-MM-DD" format

hour_offset

Integer

Hour offset for time zone shifting

count

Boolean

Do count for paging and limiting

Note on filtering by Stat.conversion_status: Due to legacy reasons, you must wrap single values in an array, such as: filters[Stat.conversion_status][conditional]=EQUAL_TO&filters[Stat.conversion_status][values][]=approved

When to Use data_start / data_end

By default, datetime values returned are in the network's default time-zone. To retrieve data in a different time zone, use the data_start, data_end, and hour_offset parameters.

The values for data_start and data_end should contain the date range you would like to set for your results. These values should match the dates you set in your filter on Stat.datetime.

The hour_offset parameter instructs the API to shift these timestamps by a number of positive or negative hours from your network's default time zone.

For example, if your network is set to utilize Eastern Standard Time (UTC-0500), and you would like to fetch reporting data in Pacific Standard Time (UTC-0800), use an hour_offset value of "-3" as shown below.

&data_start=2020-01-13
&data_end=2020-01-13
&hour_offset=-3

The timestamps will shift by -3 hours while still maintaining a date range of January 1st 2016.

Important: data_start and data_end do not filter results by date! Use Stat.datetime in the filter parameter to filter results by date.

GET Response Notes

Matching Stat model objects.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.