At a glance: Use this API to get raw data reports in CSV files.
Pull API raw data
- Pull API lets you get raw data reports for in CSV files. Learn more about raw data reports
- Filter by options available: Media source, date range, in-app event name, and geo.
- Additional capabilities in Pull API are:
- Select currency
- Select timezone
Raw data reports available via Pull API
|Raw data reports (non-organic)|
|Installs||Records non-organic installs. The record is generated when a user opens the app for the first time.
|In-app events||Records the events performed by users.
|Uninstalls||Records when a user uninstalls the app.
||Records users who after uninstalling the app, engage with a UA media source and reinstall the app during the re-attribution window.||Real-time|
|Raw data reports (organic)
||Records when the app is opened by a user for the first time.
|Organic in-app events
||Records details about events performed by users.
||Records users uninstalling the app.
||Records ad revenue for users attributed to a retargeting media source during the re-engagement window.
|Ad revenue raw data
|Attributed ad revenue
||Records ad revenue for users attributed to a media source.||Daily|
|Organic ad revenue||Records ad revenue for users not attributed to a media source.||Daily|
|Installs||Records installs identified as fraudulent and therefore not attributed to any media source.||Real-time|
|Post-attribution installs||Records in-app events from fraudulent installs and therefore not attributed at all.||Real-time|
|In-app events||Records in-app events identified as fraudulent by Protect360.||Daily|
|Post-attribution in-app events||Records in-app events for installs identified as fraudulent after being attributed to a media source or judged fraudulent without regard to the install itself.||Daily|
|Clicks||Records clicks performed by users blocked by Protect360.||Daily|
|Blocked install postbacks||Records copies of postbacks sent to a media source resulting in a blocked install.||Real-time|
|Install postbacks||Records install events generated when a user opens the app for the first time.||Daily|
|In-app event postbacks||Records in-app event postbacks sent to the media source.||Daily|
|Retargeting in-app event postbacks||Records in-app events users performed during the re-engagement window.||Real-time|
|Retargeting conversions postbacks||Records in-app events users performed during the re-engagement window.||Real-time|
Related reading: Selecting the right data delivery tool/reporting API
Using Pull API raw data
To use Pull API raw data:
- Get the API token. An admin needs to retrieve the token.
- Give your developer the API token to be used in the authentication header.
- Give your developers the parameters to input when they make the API call, as described in the sections that follow. The parameters determine what the report focuses on, how it's organized, and provide a reporting timeframe.
- Tell your developer to follow their Pull API raw data instructions in the developer hub.
|to||End date. As for
Set both the
Maximum number of rows returned by a single API call.
Filter in-app events by specified events. Select multiple events by using a comma-separated list.
Set retargeting attribution data.
To get additional fields in addition to the default fields.
Currency of the revenue and cost
Example: If the app-specific currency is EUR, by sending
[Default] Data returns using UTC.
Filter the data by country code.
Limitation: You can set only one country code filter per API call.
End date. As for
To limit (filter) the call to a specific agency.
Time frame fields
If the API results exceed the maximum, split the report using hours and minutes. Apply the following:
- from/to: yyyy-mm-dd hh:mm
- Date only = from the beginning (00:00) of the chosen date
- Date and time = from and including 00:00
- Parameter to:
- Date only = up to the end (24:00) of the chosen day
- Date and time = up to, but not including, the shown time
Example: An app owner has 1300K daily installs from all sources. To overcome the 1M row limit, the app owner splits the day into two 12-hour URI calls. See the following table for options.
|First API call||
Option A: Second API call
|Option B: Second API call||
+1 = next day at 00:00
Note: Use option A or B as they have the same results.
Additional report fields are not added to the default list of fields so that new fields don't impact your existing import and ingestion processes. Use the
additional_fields parameter to get non-default fields.
- List a field only once.
- See the list of available fields.
|Default Pull API fields|
|Attributed Touch Time|
|Event Revenue Currency|
|Event Revenue USD|
|Is Receipt Validated|
|Sub Site ID|
|Sub Param 1|
|Sub Param 2|
|Sub Param 3|
|Sub Param 4|
|Sub Param 5|
|Contributor 1 Partner|
|Contributor 1 Media Source|
|Contributor 1 Campaign|
|Contributor 1 Touch Type|
|Contributor 1 Touch Time|
|Contributor 2 Partner|
|Contributor 2 Media Source|
|Contributor 2 Campaign|
|Contributor 2 Touch Type|
|Contributor 2 Touch Time|
|Contributor 3 Partner|
|Contributor 3 Media Source|
|Contributor 3 Campaign|
|Contributor 3 Touch Type|
|Contributor 3 Touch Time|
|Customer User ID|
|Retargeting Conversion Type|
|Is Primary Attribution|
Traits and limitations
|API token type required||V2.0 token|
|Ad network access||No|
|Agency transparency||Yes. However, note that if you use both the agency filter and media source filters, the media source filters don't apply for non-transparent agencies. This means that for non-transparent agencies, all data is included; not just data from the filtered media sources.|
|Historical data||Yes. According to retention and rate limitation policies.|
API limitations for raw data.
|Install_date from and install_date_to||Install date range must be earlier than the activity date range.|
|The report doesn't contain the data expected according to the selected time range or there is a discrepancy between the raw data report and aggregated data report.||
Verify that you have set the