Affiliate_Report::getStats

Get stats report.

= Required Parameter

Name

Type

Description

fields

Array

List of fields to returnShow Supported Values

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

Name	Description
AdCampaign.name	The Ad Campaign name
Browser.display_name	The name of the Browser
Browser.id	The ID of the Browser. If a Browser was not identified, defaults to "0".
Category.id	ID of OfferCategory object
Category.name	The Offer Category name
Country.name	The Country name
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.name	The Offer name
OfferFile.display	The Offer File name
OfferUrl.name	The Offer URL name
OfferUrl.preview_url	The preview Offer URL
Stat.ad_campaign_creative_id	The Ad Campaign Creative ID. If not applicable, defaults to "0".
Stat.ad_campaign_id	ID of AdCampaign object. If not applicable, defaults to "0".
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.clicks	Aggregate field counting the number of clicks, including any marked as suspicious.
Stat.conversions	The sum of conversions
Stat.cpa	Cost per Acquisition, Payout per Conversion: (Stat.payout / Stat.conversions).
Stat.cpc	Cost per Click, Payout per Click: (Stat.payout / Stat.clicks).
Stat.cpm	Cost per Thousand Impressions: (Stat.payout / (Stat.impressions / 1000)).
Stat.ctr	Click through Rate: (Stat.clicks / Stat.impressions); note: If the Network has the "track_uniques" Preference is enabled, this is (Stat.unique_clicks / Stat.impressions).
Stat.date	The date (YYYY-MM-DD) of the stat. Limited to most recent 18 months (548 days) for Stat.affiliate_info, Stat.affiliate_info1, Stat.affiliate_info2, Stat.affiliate_info3, Stat.affiliate_info4, Stat.affiliate_info5, and Stat.source.
Stat.erpc	Electronic Rate Per Click. This refers to the payout per click.
Stat.gross_clicks	Gross clicks; available if network has Click Display set to "Both"
Stat.hour	Hour part (0 to 23) of the stat
Stat.impressions	The sum of impressions
Stat.ltr	Lead through Rate: (Stat.conversions / Stat.clicks); note: If the Network has the "track_uniques" Preference is enabled, this is (Stat.conversions / Stat.unique_clicks).
Stat.month	The month of the stat
Stat.offer_file_id	ID of OfferFile object. If not applicable, defaults to "0".
Stat.offer_id	ID of Offer object
Stat.offer_url_id	ID of Offer URL object. If not applicable, defaults to "0".
Stat.payout	The payout for this Conversion
Stat.payout_type	The Payout Type
Stat.rejected_click_rate	Fraction of incoming clicks marked as rejected due to fraud; calculated as Stat.rejected_clicks / Stat.gross_clicks. Limits response data to last 18 months (548 days) if included.
Stat.rejected_clicks	Aggregate field counting the number of clicks rejected due to fraud. Rejected clicks are not redirected to the offer URL and are included in all click-based calculations like conversion rate. Limits response data to last 18 months (548 days) if included.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.suspicious_click_rate	Fraction of incoming clicks marked as suspicious due to fraud (including rejected clicks); calculated as Stat.suspicious_clicks / Stat.gross_clicks. Limits response data to last 18 months (548 days) if included.
Stat.suspicious_clicks	Aggregate field counting the number of clicks marked as suspicious due to fraud (including rejected clicks). Non-rejected suspicious clicks are treated as normal clicks. Limits response data to last 18 months (548 days) if included.
Stat.unique_click_rate	Fraction of incoming clicks identified as unique; calculated as Stat.unique_clicks / Stat.gross_clicks.
Stat.unique_clicks	Unique clicks; available if the network has Click Display set to "Both"
Stat.week	The week of the stat. Range is 1 to 53, where week 1 is the first week with four (4) or more days. Weeks begin on Monday.
Stat.year	The year (YYYY) of the stat

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
AdCampaign.name	The Ad Campaign name
Browser.display_name	The name of the Browser
Browser.id	The ID of the Browser. If a Browser was not identified, defaults to "0".
Category.id	ID of OfferCategory object
Category.name	The Offer Category name
Country.name	The Country name
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.name	The Offer name
OfferFile.display	The Offer File name
OfferUrl.name	The Offer URL name
OfferUrl.preview_url	The preview Offer URL
Stat.ad_campaign_creative_id	The Ad Campaign Creative ID. If not applicable, defaults to "0".
Stat.ad_campaign_id	ID of AdCampaign object. If not applicable, defaults to "0".
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.clicks	Aggregate field counting the number of clicks, including any marked as suspicious.
Stat.conversions	The sum of conversions
Stat.cpa	Cost per Acquisition, Payout per Conversion: (Stat.payout / Stat.conversions).
Stat.cpc	Cost per Click, Payout per Click: (Stat.payout / Stat.clicks).
Stat.cpm	Cost per Thousand Impressions: (Stat.payout / (Stat.impressions / 1000)).
Stat.ctr	Click through Rate: (Stat.clicks / Stat.impressions); note: If the Network has the "track_uniques" Preference is enabled, this is (Stat.unique_clicks / Stat.impressions).
Stat.date	The date (YYYY-MM-DD) of the stat. Limited to most recent 18 months (548 days) for Stat.affiliate_info, Stat.affiliate_info1, Stat.affiliate_info2, Stat.affiliate_info3, Stat.affiliate_info4, Stat.affiliate_info5, and Stat.source.
Stat.erpc	Electronic Rate Per Click. This refers to the payout per click.
Stat.gross_clicks	Gross clicks; available if network has Click Display set to "Both"
Stat.hour	Hour part (0 to 23) of the stat
Stat.impressions	The sum of impressions
Stat.ltr	Lead through Rate: (Stat.conversions / Stat.clicks); note: If the Network has the "track_uniques" Preference is enabled, this is (Stat.conversions / Stat.unique_clicks).
Stat.month	The month of the stat
Stat.offer_file_id	ID of OfferFile object. If not applicable, defaults to "0".
Stat.offer_id	ID of Offer object
Stat.offer_url_id	ID of Offer URL object. If not applicable, defaults to "0".
Stat.payout	The payout for this Conversion
Stat.payout_type	The Payout Type
Stat.rejected_click_rate	Fraction of incoming clicks marked as rejected due to fraud; calculated as Stat.rejected_clicks / Stat.gross_clicks. Limits response data to last 18 months (548 days) if included.
Stat.rejected_clicks	Aggregate field counting the number of clicks rejected due to fraud. Rejected clicks are not redirected to the offer URL and are included in all click-based calculations like conversion rate. Limits response data to last 18 months (548 days) if included.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.suspicious_click_rate	Fraction of incoming clicks marked as suspicious due to fraud (including rejected clicks); calculated as Stat.suspicious_clicks / Stat.gross_clicks. Limits response data to last 18 months (548 days) if included.
Stat.suspicious_clicks	Aggregate field counting the number of clicks marked as suspicious due to fraud (including rejected clicks). Non-rejected suspicious clicks are treated as normal clicks. Limits response data to last 18 months (548 days) if included.
Stat.unique_click_rate	Fraction of incoming clicks identified as unique; calculated as Stat.unique_clicks / Stat.gross_clicks.
Stat.unique_clicks	Unique clicks; available if the network has Click Display set to "Both"
Stat.week	The week of the stat. Range is 1 to 53, where week 1 is the first week with four (4) or more days. Weeks begin on Monday.
Stat.year	The year (YYYY) of the stat

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
AdCampaign.name	The Ad Campaign name
Browser.display_name	The name of the Browser
Browser.id	The ID of the Browser. If a Browser was not identified, defaults to "0".
Category.id	ID of OfferCategory object
Category.name	The Offer Category name
Country.name	The Country name
Goal.name	Name of the goal; available if network has Offer Goals enabled. Returns the string "Default" for unnamed default goals.
Offer.name	The Offer name
OfferFile.display	The Offer File name
OfferUrl.name	The Offer URL name
OfferUrl.preview_url	The preview Offer URL
Stat.ad_campaign_creative_id	The Ad Campaign Creative ID. If not applicable, defaults to "0".
Stat.ad_campaign_id	ID of AdCampaign object. If not applicable, defaults to "0".
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.clicks	Aggregate field counting the number of clicks, including any marked as suspicious.
Stat.conversions	The sum of conversions
Stat.cpa	Cost per Acquisition, Payout per Conversion: (Stat.payout / Stat.conversions).
Stat.cpc	Cost per Click, Payout per Click: (Stat.payout / Stat.clicks).
Stat.cpm	Cost per Thousand Impressions: (Stat.payout / (Stat.impressions / 1000)).
Stat.ctr	Click through Rate: (Stat.clicks / Stat.impressions); note: If the Network has the "track_uniques" Preference is enabled, this is (Stat.unique_clicks / Stat.impressions).
Stat.date	The date (YYYY-MM-DD) of the stat. Limited to most recent 18 months (548 days) for Stat.affiliate_info, Stat.affiliate_info1, Stat.affiliate_info2, Stat.affiliate_info3, Stat.affiliate_info4, Stat.affiliate_info5, and Stat.source.
Stat.erpc	Electronic Rate Per Click. This refers to the payout per click.
Stat.gross_clicks	Gross clicks; available if network has Click Display set to "Both"
Stat.hour	Hour part (0 to 23) of the stat
Stat.impressions	The sum of impressions
Stat.ltr	Lead through Rate: (Stat.conversions / Stat.clicks); note: If the Network has the "track_uniques" Preference is enabled, this is (Stat.conversions / Stat.unique_clicks).
Stat.month	The month of the stat
Stat.offer_file_id	ID of OfferFile object. If not applicable, defaults to "0".
Stat.offer_id	ID of Offer object
Stat.offer_url_id	ID of Offer URL object. If not applicable, defaults to "0".
Stat.payout	The payout for this Conversion
Stat.payout_type	The Payout Type
Stat.rejected_click_rate	Fraction of incoming clicks marked as rejected due to fraud; calculated as Stat.rejected_clicks / Stat.gross_clicks. Limits response data to last 18 months (548 days) if included.
Stat.rejected_clicks	Aggregate field counting the number of clicks rejected due to fraud. Rejected clicks are not redirected to the offer URL and are included in all click-based calculations like conversion rate. Limits response data to last 18 months (548 days) if included.
Stat.source	Affiliate source passed in by affiliate when session was started
Stat.suspicious_click_rate	Fraction of incoming clicks marked as suspicious due to fraud (including rejected clicks); calculated as Stat.suspicious_clicks / Stat.gross_clicks. Limits response data to last 18 months (548 days) if included.
Stat.suspicious_clicks	Aggregate field counting the number of clicks marked as suspicious due to fraud (including rejected clicks). Non-rejected suspicious clicks are treated as normal clicks. Limits response data to last 18 months (548 days) if included.
Stat.unique_click_rate	Fraction of incoming clicks identified as unique; calculated as Stat.unique_clicks / Stat.gross_clicks.
Stat.unique_clicks	Unique clicks; available if the network has Click Display set to "Both"
Stat.week	The week of the stat. Range is 1 to 53, where week 1 is the first week with four (4) or more days. Weeks begin on Monday.
Stat.year	The year (YYYY) of the stat

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

currency

String

Default currency. Format ISO-4217. Example: 'USD', 'EUR', 'CNY'.

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

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 date range you set in your filter on Stat.date.

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