Advertiser_Report::getStats

Retrieve aggregated offer stats like number of conversions and total costs (to be received by network).

= 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
Browser.display_name	Name of the web browser
Browser.id	ID of the web browser. Defaults to "0" if the browser can't be identified. For more information, reference our list of browser ID codes in the Network API documentation.
Category.id	ID of offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Category.name	Name of offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Country.name	Name of the country
Goal.name	Name of the goal; returns the string "Default" for unnamed default goals
Offer.name	Name of the offer
OfferFile.display	Display name of the OfferFile
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
Stat.affiliate_id	ID of affiliate
Stat.browser_id	ID of the web browser. Defaults to "0" if the browser can't be identified. For more information, reference our list of browser ID codes in the Network API documentation.
Stat.clicks	Aggregate field counting the number of clicks
Stat.conversions	Aggregate field counting the number of conversions
Stat.cost	Total cost (to be received by network)
Stat.count	Aggregate field counting the number of matching rows
Stat.cr	Conversion rate: (Conversions / Clicks). If the network has the "track_uniques" preference enabled, this is instead (Conversions / Unique clicks).
Stat.date	Date (YYYY-MM-DD) the event took place
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.goal_id	ID of goal; defaults to "0" if none is set
Stat.gross_clicks	Sum of gross clicks; only available if the network has the Click Display setting set to "Both".
Stat.hour	Hour (0 to 23) the events took place
Stat.impressions	Sum of impressions
Stat.month	Month (1 to 12) the events took place
Stat.offer_file_id	ID of OfferFile object; defaults to "0" if none is set
Stat.offer_id	ID of the offer
Stat.offer_url_id	ID of offer URL object; defaults to "0" if none is set
Stat.total_sales	Total sales amount
Stat.unique_clicks	Sum of unique clicks; only available if the network has the Click Display setting set to "Both".
Stat.week	Week the events took place, appended to the year of the event. 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 events 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
Browser.display_name	Name of the web browser
Browser.id	ID of the web browser. Defaults to "0" if the browser can't be identified. For more information, reference our list of browser ID codes in the Network API documentation.
Category.id	ID of offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Category.name	Name of offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Country.name	Name of the country
Goal.name	Name of the goal; returns the string "Default" for unnamed default goals
Offer.name	Name of the offer
OfferFile.display	Display name of the OfferFile
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
Stat.affiliate_id	ID of affiliate
Stat.browser_id	ID of the web browser. Defaults to "0" if the browser can't be identified. For more information, reference our list of browser ID codes in the Network API documentation.
Stat.clicks	Aggregate field counting the number of clicks
Stat.conversions	Aggregate field counting the number of conversions
Stat.cost	Total cost (to be received by network)
Stat.count	Aggregate field counting the number of matching rows
Stat.cr	Conversion rate: (Conversions / Clicks). If the network has the "track_uniques" preference enabled, this is instead (Conversions / Unique clicks).
Stat.date	Date (YYYY-MM-DD) the event took place
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.goal_id	ID of goal; defaults to "0" if none is set
Stat.gross_clicks	Sum of gross clicks; only available if the network has the Click Display setting set to "Both".
Stat.hour	Hour (0 to 23) the events took place
Stat.impressions	Sum of impressions
Stat.month	Month (1 to 12) the events took place
Stat.offer_file_id	ID of OfferFile object; defaults to "0" if none is set
Stat.offer_id	ID of the offer
Stat.offer_url_id	ID of offer URL object; defaults to "0" if none is set
Stat.total_sales	Total sales amount
Stat.unique_clicks	Sum of unique clicks; only available if the network has the Click Display setting set to "Both".
Stat.week	Week the events took place, appended to the year of the event. 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 events 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
Browser.display_name	Name of the web browser
Browser.id	ID of the web browser. Defaults to "0" if the browser can't be identified. For more information, reference our list of browser ID codes in the Network API documentation.
Category.id	ID of offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Category.name	Name of offer category; including this field can cause duplicate rows if an offer belongs to more than one category
Country.name	Name of the country
Goal.name	Name of the goal; returns the string "Default" for unnamed default goals
Offer.name	Name of the offer
OfferFile.display	Display name of the OfferFile
OfferUrl.name	Name of the offer URL
OfferUrl.preview_url	Preview link for the offer URL
Stat.affiliate_id	ID of affiliate
Stat.browser_id	ID of the web browser. Defaults to "0" if the browser can't be identified. For more information, reference our list of browser ID codes in the Network API documentation.
Stat.clicks	Aggregate field counting the number of clicks
Stat.conversions	Aggregate field counting the number of conversions
Stat.cost	Total cost (to be received by network)
Stat.count	Aggregate field counting the number of matching rows
Stat.cr	Conversion rate: (Conversions / Clicks). If the network has the "track_uniques" preference enabled, this is instead (Conversions / Unique clicks).
Stat.date	Date (YYYY-MM-DD) the event took place
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.goal_id	ID of goal; defaults to "0" if none is set
Stat.gross_clicks	Sum of gross clicks; only available if the network has the Click Display setting set to "Both".
Stat.hour	Hour (0 to 23) the events took place
Stat.impressions	Sum of impressions
Stat.month	Month (1 to 12) the events took place
Stat.offer_file_id	ID of OfferFile object; defaults to "0" if none is set
Stat.offer_id	ID of the offer
Stat.offer_url_id	ID of offer URL object; defaults to "0" if none is set
Stat.total_sales	Total sales amount
Stat.unique_clicks	Sum of unique clicks; only available if the network has the Click Display setting set to "Both".
Stat.week	Week the events took place, appended to the year of the event. 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 events 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.