Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.everflow.io/llms.txt

Use this file to discover all available pages before exploring further.

The Everflow UI offers many different types of reports and the API is no different. There is not, however, a one-to-one relationship between every report offered in the UI and the API endpoints as certain API endpoints power many different reports.
Are you looking to fetch all your tracking data? If so, the Firehose might be suited for your use case. Firehose streams clicks, conversions, impressions, and conversion updates to your infrastructure in real time with sub-second latency and no rate limiting.
Please note that reporting data is subject to Everflow’s data retention policy.

​
Aggregated data reports

Aggregated data reports are reports like: Offer Reporting, Partner Report, Advertiser Report, Flex Report, Smart Link Report, Daily Report in the Everflow UI. They allow you to pivot your data based on the columns of your choice while also applying filters to narrow down the scope of the data returned. The endpoints that power these reports will allow you to pull data similar to this in the UI.

Entity Table

Pull aggregated reporting data in a table format with column and filter support.

Entity Summary

Pull a summary of aggregated reporting data.

Entity Table Export

Export aggregated reporting data in CSV format.

​
Dashboard stats

The endpoints documented here power the cards that appear on the dashboard of the Everflow UI after you log in. While these endpoints are not as powerful or granular as the aggregated data reports, they can be useful to quickly pull summaries.

Dashboard Summary

Pull the dashboard summary statistics.

​
Raw clicks

These endpoints allow you to pull unaggregated data where each click is a “row” of data. A set of clicks can be pulled at once and each click row will contain details about the event (device information, geolocation, query parameters). The set of clicks pulled can be filtered based on different criteria (offer, partner, sub id value, etc.) The endpoints documented in this section power the Click Report as well as the Flowchart in the Everflow UI.

Get Clicks

Pull raw click data with filtering support.

Stream Clicks

Stream raw click data for large datasets.

​
Invalid clicks

These endpoints allow you to pull unaggregated invalid click data where each invalid click is a “row” of data. A set of clicks can be pulled at once and each click row will contain details about the event (device information, geolocation, query parameters). The set of clicks pulled can be filtered based on different criteria (offer, partner, sub id value, etc.) The endpoints documented in this section power the Invalid Click Report in the Everflow UI.

Invalid Clicks

Pull raw invalid click data with filtering support.

​
Raw conversions

These endpoints allow you to pull unaggregated conversion data where each conversion is a “row” of data. The set of conversions pulled will contain detailed information about each conversion (payout/revenue information, adv values, geolocation, etc.). The set of conversions pulled can be filtered based on different criteria (offer, partner, country, etc.) Although it is referred to as the “conversion” report, post-conversion events are also returned by these endpoints. The conversions can also be extracted in CSV format, effectively mimicking the export functionality from the UI.

Get Conversions

Pull raw conversion data by query parameters.

Search Conversions

Search raw conversion data with filters.

Conversions Summary

Pull a summary of raw conversion data.

Export Conversions

Export raw conversions in CSV format.

Conversion By Email

Look up conversions associated with an email address.

​
Raw impressions

Similar in functionality to the raw clicks report, this endpoint will let you pull raw impressions where each impression is a “row” of data.
This endpoint will only be available if the impression package is activated on your Everflow account.

Stream Impressions

Stream raw impression data.

​
Event report

The endpoint that powers the Event Report in the Everflow UI. Although “events” can also be extracted from the raw conversions endpoints, the Event Report aggregates the statistics per event.

Events Per Transaction

Pull aggregated event statistics per transaction.

Post Conversions

Pull post-conversion event data.

Export Post Conversions

Export post-conversion events in CSV format.

​
Affiliate postback report

The endpoint that powers the Affiliate Postback Report in the Everflow UI. This will give you a non-aggregated list of affiliate postbacks over a period of time with the optional use of filters.

Affiliate Postback Log

Pull affiliate postback log data.

Advertiser Postback Log

Pull advertiser postback log data.

Export Affiliate Postbacks

Export affiliate postback data in CSV format.

​
Data supplements

This suite of endpoints allows you to manage reporting adjustments, also known as supplements. Use these to manually inject, fetch, or revert aggregated data, such as offline conversions or financial corrections—to ensure your reporting is reconciled and accurate.
Supplements do not alter raw reporting data but instead provide a corrective layer that can be seen on the aggregated reporting data.

Create Supplements

Create reporting adjustments.

Revert Supplements

Undo previously applied reporting adjustments.

Search Supplements

Search supplements in a table format.

Export Supplements

Export supplement data in CSV or JSON format.

Get Adjustments

Retrieve reporting adjustments with pre-adjustment snapshots.

​
Raw on hold conversions

These endpoints allow you to pull unaggregated on hold conversion data where each on hold conversion is a “row” of data. The set of on hold conversions pulled will contain detailed information about each on hold conversion (revenue information, etc.). The set of on hold conversions pulled can be filtered based on different criteria (offer, country, etc.) Although it is referred to as the “on hold conversion” report, post-conversion events are also returned by these endpoints.

Update On Hold

Update on hold conversion statuses.

Search On Hold

Search on hold conversions with filters.

Export On Hold

Export on hold conversions in CSV format.

​
Other reporting endpoints

Transactions

Pull transaction details.

Transaction Flowchart

Pull the flowchart for a specific transaction.

Variance Report

Pull variance reporting data.

Referrals

Pull referral reporting data.

Refunds

Pull refund reporting data.

MTTI

Pull mean time to install data.

Currency Rates

Pull currency exchange rates.

Offer Caps

Pull offer cap reporting data.

Offer Caps Summary

Pull offer cap summary data.

Offer Group Caps

Pull offer group cap reporting data.

Custom Caps

Pull custom cap reporting data.