Report::getConversions Method

Jump to: When to Use data_start / data_end | Filtering for Multiple Values on the Same Field | Potential Performance Issues with Stat.Date | If You Receive a 504 Response | GET Response Notes | API Call Builder

Get a conversion report. Time frame for response data is limited to the last 25 months (762 days).

Note: Some fields related to personal data (like Stat.ip) reduce the time frame available for retrieval when included. For more information, see our support documentation on the Importance of Securing Data in HasOffers.

Deprecation notice: We are deprecating the conversion 'id' field (also called conversion.id, Stat.id, conversion_id  in some contexts)  and migrating to tune_event_id. Use the new tune_event_id in all places where you would have used the conversion id, unless otherwise specified.

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 or Stat.modified_datetime 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.

Potential Performance Issues with Stat.Date

For very large result sets, you may experience intermittent timeout issues when filtering by Stat.date. We recommend filtering with Stat.datetime instead of Stat.date.

If You Receive a 504 Response

If you receive a HTTP 504 response to your call, your result set is too large to retrieve in a single call. We recommend breaking your requested time in half and make two calls by filtering on Stat.datetime.

GET Response Notes

Returns an array of matching ConversionReport model objects

API Call Builder