Report::getConversions Method

Get Conversions Report.

NameTypeDescription
NetworkId UrlNetwork ID
NetworkToken String Network token
Target String This calls action target
Method String This calls action method
fields Array List of fields to return; defaults to all fieldsShow Supported Values
groupsArray Group by certain fieldsShow Supported Values
filtersFilter type objectArray of field values to filter results byShow Filterable Fields
sortSort Array of fields and directions to sort results byShow Sortable Fields
limitIntegerObjects per page to return; defaults to returning all found
pageIntegerResult page to return, based on limit value; defaults to 1
totalsBoolean Get totals on aggregate fields
data_startDate Start of date range for time zone shifting; use "YYYY-MM-DD" format
data_endDate End of date range for time zone shifting; use "YYYY-MM-DD" format
hour_offsetIntegerHour offset for time zone shifting
countBoolean If only the count of matching results, and not the results themselves, is desired
status_update_fieldsArray Update cached conversion results with conversion updated status. This is an associative array of conversion_id to the newly updated status. Example: [1234 => 'approved', 1235 => 'rejected', ...]

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: "2016-01-01"
data_end: "2016-01-01"
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

List of Stat model objects.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.
Have a Question? Please contact support@tune.com for technical support.