Report::getStats | TUNE Dev Hub

Jump to: When to Use data_start / data_end | Filtering for Multiple Values on the Same Field | GET Response Notes | API Call Builder

Retrieve a stats report that contains aggregated stats for clicks, conversions, and other data points.

Note: Some fields related to mobile stats (like Stat.device_os) reduce the time frame available for retrieval when included.

= 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	Name of the ad campaign
Advertiser.company	Name of the advertiser company
Advertiser.ref_id	Optional ID used to reference offers or campaigns in advertisers' third-party systems
AdvertiserManager.full_name	First and last names of the employee who is the account manager for the advertiser
AdvertiserTag.name	Custom tag applied to the advertiser
Affiliate.company	Name of the affiliate company
Affiliate.ref_id	Optional ID used to reference offers or campaigns in affiliates' third-party systems
AffiliateManager.full_name	First and last names of the employee who is the account manager for the affiliate
AffiliateTag.name	Custom tag applied to the affiliate
Category.id	ID of Offer Category object; note: Including this field can cause duplicate rows if an offer belongs to more than one category
Category.name	Name of the offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Country.name	Name of the country where action occurred; determined by Stat.session_ip for conversions
Goal.name	Name of the goal. Returns the string "Default" for unnamed default goals.
Offer.display_advertiser	Whether or not the advertiser is visible to users who otherwise lack permission to view them in the application
Offer.name	Name of the offer
Offer.ref_id	ID of an optional object used to reference campaigns or offers in third party systems
OfferChannel.name	Channel tag applied to the offer
OfferConversionType.name	Conversion Type tag applied to the offer
OfferFile.display	Display name of the OfferFile
OfferIncentive.name	Incentive tag applied to the offer
OfferMediaPlacement.name	Media Placement tag applied to the offer
OfferOperatingSystem.name	Operating System tag applied to the offer
OfferTag.name	Custom tag applied to the offer
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
OfferVertical.name	Vertical tag applied to the offer
Region.name	Name of region where stats occurred; determined by Stat.session_ip for conversions
Stat.ad_campaign_creative_id	Ad campaign creative ID
Stat.ad_campaign_id	ID of AdCampaign object
Stat.advertiser_id	ID of Advertiser object
Stat.advertiser_manager_id	ID of the employee who is the account manager for the advertiser. If none is set, defaults to "0".
Stat.affiliate_count	Aggregate field counting the distinct number of Affiliate IDs
Stat.affiliate_id	ID of Affiliate object
Stat.affiliate_info1	Affiliate sub 1 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info2	Affiliate sub 2 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info3	Affiliate sub 3 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info4	Affiliate sub 4 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info5	Affiliate sub 5 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_manager_id	ID of the employee who is the account manager for the affiliate. If none is set, defaults to "0".
Stat.browser_id	This parameter has been deprecated. Deprecated. ID of the web browser. Defaults to "0" if the browser can't be identified.
Stat.city_name	Name of city where action occurred; determined by Stat.ip for conversions
Stat.clicks	Aggregate field counting the number of clicks, including any marked as suspicious
Stat.conversions	Aggregate field counting the number of conversions
Stat.count	Aggregate field counting the number of matching rows
Stat.country_code	Country code of the country where action occurred (aligned with ISO 3166-2); determined by Stat.session_ip for conversions
Stat.cpa	Cost (payout) per action (conversion); calculated as Stat.payout / Stat.conversions
Stat.cpc	Cost (payout) per click; calculated as Stat.payout / Stat.clicks
Stat.cpm	Cost per thousand Impressions: (Stat.payout / (Stat.impressions / 1000)).
Stat.creative_url_id	ID of the offer URL. If none is set, defaults to "0".
Stat.ctr	Click-through rate, calculated as Stat.clicks / Stat.impressions; if the "track_uniques" preference is enabled, this is instead calculated as Stat.unique_clicks / Stat.impressions
Stat.date	Date of the event.
Stat.device_brand	Brand of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_model	Model of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_os	OS of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_os_version	OS Version of the device; limits response data to last 6 months (184 days) if included
Stat.epc	Earnings per click: ((Stat.revenue - Stat.payout) / Stat.clicks)
Stat.erpc	Electronic rate per click, referring to the amount paid out to the affiliate per click
Stat.flagged_reason	Reason a click was marked as suspicious due to fraud (including rejected clicks). For clicks not marked as suspicious, this field has a value of "Not Flagged". Limits response data to last 18 months (548 days) if included.
Stat.goal_id	ID of Goal object If none is set, defaults to "0".
Stat.gross_clicks	Sum of gross clicks
Stat.gross_ctr	Gross click-through rate, calculated as Stat.gross_clicks / Stat.impressions
Stat.hour	Hour (0 to 23) of the event
Stat.impressions	Sum of impressions
Stat.ltr	Lead through rate, calculated as Stat.conversions / Stat.clicks; if the "track_uniques" preference is enabled, this is instead calculated as Stat.conversions / Stat.unique_clicks
Stat.mobile_carrier	Carrier of the device; limits response data to last 6 months (184 days) if included
Stat.month	Month (1 to 12) of the event
Stat.offer_count	Aggregate field counting the distinct number of offer IDs
Stat.offer_file_id	ID of OfferFile object; defaults to "0" if none is set
Stat.offer_id	ID of Offer object
Stat.offer_url_id	ID of offer URL object; defaults to "0" if none is set
Stat.payout	Affiliate payout amount
Stat.payout_type	Offer (or Goal, if applicable) payout type
Stat.profit	Amount of profit (Stat.revenue - Stat.payout).
Stat.region_code	Region code of region where action occurred; determined by Stat.session_ip for conversions
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 from 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.revenue	Amount of revenue generated
Stat.revenue_type	Offer (or Goal, if applicable) revenue type
Stat.rpa	Revenue per Acquisition, Revenue per Conversion: (Stat.revenue / Stat.conversions).
Stat.rpc	Revenue per Click: (Stat.revenue / Stat.clicks); note: If the "track_uniques" Preference is enabled, this is (Stat.revenue / Stat.unique_clicks).
Stat.rpm	Revenue per thousand Impressions: (Stat.revenue / (Stat.impressions / 1000)).
Stat.sale_amount	The sale amount
Stat.source	Affiliate source passed in by the affiliate when the session was started. Empty string if none. Limits response data to last 18 months (548 days) if included.
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	Sum of unique clicks
Stat.unique_ctr	Unique Click through Rate: (Stat.unique_clicks / Stat.impressions).
Stat.week	Week in which the event 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 (YYYY) the event took place

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	Name of the ad campaign
Advertiser.company	Name of the advertiser company
Advertiser.ref_id	Optional ID used to reference offers or campaigns in advertisers' third-party systems
AdvertiserManager.full_name	First and last names of the employee who is the account manager for the advertiser
AdvertiserTag.name	Custom tag applied to the advertiser
Affiliate.company	Name of the affiliate company
Affiliate.ref_id	Optional ID used to reference offers or campaigns in affiliates' third-party systems
AffiliateManager.full_name	First and last names of the employee who is the account manager for the affiliate
AffiliateTag.name	Custom tag applied to the affiliate
Category.id	ID of Offer Category object; note: Including this field can cause duplicate rows if an offer belongs to more than one category
Category.name	Name of the offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Country.name	Name of the country where action occurred; determined by Stat.session_ip for conversions
Goal.name	Name of the goal. Returns the string "Default" for unnamed default goals.
Offer.display_advertiser	Whether or not the advertiser is visible to users who otherwise lack permission to view them in the application
Offer.name	Name of the offer
Offer.ref_id	ID of an optional object used to reference campaigns or offers in third party systems
OfferChannel.name	Channel tag applied to the offer
OfferConversionType.name	Conversion Type tag applied to the offer
OfferFile.display	Display name of the OfferFile
OfferIncentive.name	Incentive tag applied to the offer
OfferMediaPlacement.name	Media Placement tag applied to the offer
OfferOperatingSystem.name	Operating System tag applied to the offer
OfferTag.name	Custom tag applied to the offer
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
OfferVertical.name	Vertical tag applied to the offer
Region.name	Name of region where stats occurred; determined by Stat.session_ip for conversions
Stat.ad_campaign_creative_id	Ad campaign creative ID
Stat.ad_campaign_id	ID of AdCampaign object
Stat.advertiser_id	ID of Advertiser object
Stat.advertiser_manager_id	ID of the employee who is the account manager for the advertiser. If none is set, defaults to "0".
Stat.affiliate_count	Aggregate field counting the distinct number of Affiliate IDs
Stat.affiliate_id	ID of Affiliate object
Stat.affiliate_info1	Affiliate sub 1 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info2	Affiliate sub 2 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info3	Affiliate sub 3 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info4	Affiliate sub 4 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info5	Affiliate sub 5 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_manager_id	ID of the employee who is the account manager for the affiliate. If none is set, defaults to "0".
Stat.browser_id	This parameter has been deprecated. Deprecated. ID of the web browser. Defaults to "0" if the browser can't be identified.
Stat.city_name	Name of city where action occurred; determined by Stat.ip for conversions
Stat.clicks	Aggregate field counting the number of clicks, including any marked as suspicious
Stat.conversions	Aggregate field counting the number of conversions
Stat.count	Aggregate field counting the number of matching rows
Stat.country_code	Country code of the country where action occurred (aligned with ISO 3166-2); determined by Stat.session_ip for conversions
Stat.cpa	Cost (payout) per action (conversion); calculated as Stat.payout / Stat.conversions
Stat.cpc	Cost (payout) per click; calculated as Stat.payout / Stat.clicks
Stat.cpm	Cost per thousand Impressions: (Stat.payout / (Stat.impressions / 1000)).
Stat.creative_url_id	ID of the offer URL. If none is set, defaults to "0".
Stat.ctr	Click-through rate, calculated as Stat.clicks / Stat.impressions; if the "track_uniques" preference is enabled, this is instead calculated as Stat.unique_clicks / Stat.impressions
Stat.date	Date of the event.
Stat.device_brand	Brand of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_model	Model of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_os	OS of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_os_version	OS Version of the device; limits response data to last 6 months (184 days) if included
Stat.epc	Earnings per click: ((Stat.revenue - Stat.payout) / Stat.clicks)
Stat.erpc	Electronic rate per click, referring to the amount paid out to the affiliate per click
Stat.flagged_reason	Reason a click was marked as suspicious due to fraud (including rejected clicks). For clicks not marked as suspicious, this field has a value of "Not Flagged". Limits response data to last 18 months (548 days) if included.
Stat.goal_id	ID of Goal object If none is set, defaults to "0".
Stat.gross_clicks	Sum of gross clicks
Stat.gross_ctr	Gross click-through rate, calculated as Stat.gross_clicks / Stat.impressions
Stat.hour	Hour (0 to 23) of the event
Stat.impressions	Sum of impressions
Stat.ltr	Lead through rate, calculated as Stat.conversions / Stat.clicks; if the "track_uniques" preference is enabled, this is instead calculated as Stat.conversions / Stat.unique_clicks
Stat.mobile_carrier	Carrier of the device; limits response data to last 6 months (184 days) if included
Stat.month	Month (1 to 12) of the event
Stat.offer_count	Aggregate field counting the distinct number of offer IDs
Stat.offer_file_id	ID of OfferFile object; defaults to "0" if none is set
Stat.offer_id	ID of Offer object
Stat.offer_url_id	ID of offer URL object; defaults to "0" if none is set
Stat.payout	Affiliate payout amount
Stat.payout_type	Offer (or Goal, if applicable) payout type
Stat.profit	Amount of profit (Stat.revenue - Stat.payout).
Stat.region_code	Region code of region where action occurred; determined by Stat.session_ip for conversions
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 from 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.revenue	Amount of revenue generated
Stat.revenue_type	Offer (or Goal, if applicable) revenue type
Stat.rpa	Revenue per Acquisition, Revenue per Conversion: (Stat.revenue / Stat.conversions).
Stat.rpc	Revenue per Click: (Stat.revenue / Stat.clicks); note: If the "track_uniques" Preference is enabled, this is (Stat.revenue / Stat.unique_clicks).
Stat.rpm	Revenue per thousand Impressions: (Stat.revenue / (Stat.impressions / 1000)).
Stat.sale_amount	The sale amount
Stat.source	Affiliate source passed in by the affiliate when the session was started. Empty string if none. Limits response data to last 18 months (548 days) if included.
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	Sum of unique clicks
Stat.unique_ctr	Unique Click through Rate: (Stat.unique_clicks / Stat.impressions).
Stat.week	Week in which the event 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 (YYYY) the event took place

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	Name of the ad campaign
Advertiser.company	Name of the advertiser company
Advertiser.ref_id	Optional ID used to reference offers or campaigns in advertisers' third-party systems
AdvertiserManager.full_name	First and last names of the employee who is the account manager for the advertiser
AdvertiserTag.name	Custom tag applied to the advertiser
Affiliate.company	Name of the affiliate company
Affiliate.ref_id	Optional ID used to reference offers or campaigns in affiliates' third-party systems
AffiliateManager.full_name	First and last names of the employee who is the account manager for the affiliate
AffiliateTag.name	Custom tag applied to the affiliate
Category.id	ID of Offer Category object; note: Including this field can cause duplicate rows if an offer belongs to more than one category
Category.name	Name of the offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Country.name	Name of the country where action occurred; determined by Stat.session_ip for conversions
Goal.name	Name of the goal. Returns the string "Default" for unnamed default goals.
Offer.display_advertiser	Whether or not the advertiser is visible to users who otherwise lack permission to view them in the application
Offer.name	Name of the offer
Offer.ref_id	ID of an optional object used to reference campaigns or offers in third party systems
OfferChannel.name	Channel tag applied to the offer
OfferConversionType.name	Conversion Type tag applied to the offer
OfferFile.display	Display name of the OfferFile
OfferIncentive.name	Incentive tag applied to the offer
OfferMediaPlacement.name	Media Placement tag applied to the offer
OfferOperatingSystem.name	Operating System tag applied to the offer
OfferTag.name	Custom tag applied to the offer
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
OfferVertical.name	Vertical tag applied to the offer
Region.name	Name of region where stats occurred; determined by Stat.session_ip for conversions
Stat.ad_campaign_creative_id	Ad campaign creative ID
Stat.ad_campaign_id	ID of AdCampaign object
Stat.advertiser_id	ID of Advertiser object
Stat.advertiser_manager_id	ID of the employee who is the account manager for the advertiser. If none is set, defaults to "0".
Stat.affiliate_count	Aggregate field counting the distinct number of Affiliate IDs
Stat.affiliate_id	ID of Affiliate object
Stat.affiliate_info1	Affiliate sub 1 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info2	Affiliate sub 2 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info3	Affiliate sub 3 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info4	Affiliate sub 4 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_info5	Affiliate sub 5 passed in by the affiliate when the session was started. Limits response data to last 18 months (548 days) if included.
Stat.affiliate_manager_id	ID of the employee who is the account manager for the affiliate. If none is set, defaults to "0".
Stat.browser_id	This parameter has been deprecated. Deprecated. ID of the web browser. Defaults to "0" if the browser can't be identified.
Stat.city_name	Name of city where action occurred; determined by Stat.ip for conversions
Stat.clicks	Aggregate field counting the number of clicks, including any marked as suspicious
Stat.conversions	Aggregate field counting the number of conversions
Stat.count	Aggregate field counting the number of matching rows
Stat.country_code	Country code of the country where action occurred (aligned with ISO 3166-2); determined by Stat.session_ip for conversions
Stat.cpa	Cost (payout) per action (conversion); calculated as Stat.payout / Stat.conversions
Stat.cpc	Cost (payout) per click; calculated as Stat.payout / Stat.clicks
Stat.cpm	Cost per thousand Impressions: (Stat.payout / (Stat.impressions / 1000)).
Stat.creative_url_id	ID of the offer URL. If none is set, defaults to "0".
Stat.ctr	Click-through rate, calculated as Stat.clicks / Stat.impressions; if the "track_uniques" preference is enabled, this is instead calculated as Stat.unique_clicks / Stat.impressions
Stat.date	Date of the event.
Stat.device_brand	Brand of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_model	Model of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_os	OS of the device. Limits response data to last 6 months (184 days) if included.
Stat.device_os_version	OS Version of the device; limits response data to last 6 months (184 days) if included
Stat.epc	Earnings per click: ((Stat.revenue - Stat.payout) / Stat.clicks)
Stat.erpc	Electronic rate per click, referring to the amount paid out to the affiliate per click
Stat.flagged_reason	Reason a click was marked as suspicious due to fraud (including rejected clicks). For clicks not marked as suspicious, this field has a value of "Not Flagged". Limits response data to last 18 months (548 days) if included.
Stat.goal_id	ID of Goal object If none is set, defaults to "0".
Stat.gross_clicks	Sum of gross clicks
Stat.gross_ctr	Gross click-through rate, calculated as Stat.gross_clicks / Stat.impressions
Stat.hour	Hour (0 to 23) of the event
Stat.impressions	Sum of impressions
Stat.ltr	Lead through rate, calculated as Stat.conversions / Stat.clicks; if the "track_uniques" preference is enabled, this is instead calculated as Stat.conversions / Stat.unique_clicks
Stat.mobile_carrier	Carrier of the device; limits response data to last 6 months (184 days) if included
Stat.month	Month (1 to 12) of the event
Stat.offer_count	Aggregate field counting the distinct number of offer IDs
Stat.offer_file_id	ID of OfferFile object; defaults to "0" if none is set
Stat.offer_id	ID of Offer object
Stat.offer_url_id	ID of offer URL object; defaults to "0" if none is set
Stat.payout	Affiliate payout amount
Stat.payout_type	Offer (or Goal, if applicable) payout type
Stat.profit	Amount of profit (Stat.revenue - Stat.payout).
Stat.region_code	Region code of region where action occurred; determined by Stat.session_ip for conversions
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 from 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.revenue	Amount of revenue generated
Stat.revenue_type	Offer (or Goal, if applicable) revenue type
Stat.rpa	Revenue per Acquisition, Revenue per Conversion: (Stat.revenue / Stat.conversions).
Stat.rpc	Revenue per Click: (Stat.revenue / Stat.clicks); note: If the "track_uniques" Preference is enabled, this is (Stat.revenue / Stat.unique_clicks).
Stat.rpm	Revenue per thousand Impressions: (Stat.revenue / (Stat.impressions / 1000)).
Stat.sale_amount	The sale amount
Stat.source	Affiliate source passed in by the affiliate when the session was started. Empty string if none. Limits response data to last 18 months (548 days) if included.
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	Sum of unique clicks
Stat.unique_ctr	Unique Click through Rate: (Stat.unique_clicks / Stat.impressions).
Stat.week	Week in which the event 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 (YYYY) the event took place

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. Examples: '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.

Filtering for Multiple Values on the Same Field

You can enter multiple values for the same field when filtering, to create an OR filter on that field. For example, if you want results for three different offers collected together, form that section of the call as:

&filters[Stat.offer_id][conditional]=EQUAL_TO
&filters[Stat.offer_id][values][]=123
&filters[Stat.offer_id][values][]=456
&filters[Stat.offer_id][values][]=789

This returns all entries relating to offer IDs 123, 456, and 789. For more on filtering, see Filtering, Paging & Sorting.

GET Response Notes

Returns an array of matching StatReport model objects

API Call Builder

Javascript is required to use the API Call Builder.