Home
User Guide
Getting Started
Rate Limiting
Paging
Working with Rulesets
Network API
Labels
Custom Settings
Network Settings
Offers
Campaigns
Creatives
Affiliates
Postbacks
Advertisers
Reporting
Affiliate API
Offers
Reporting
Advertiser API
Offers
Reporting
Metadata API
General
Integrate
Tutorials
Code Examples
Everflow SDK
Reporting
Get a sub id report
POST
/v1/affiliates/reporting/sub/:subVariable
Get a daily report
POST
/v1/affiliates/reporting/daily
Get an offer report
POST
/v1/affiliates/reporting/offer
Get report based on specified entity.
POST
/v1/affiliates/reporting/entity
Get the conversion report.
POST
/v1/affiliates/reporting/conversions
Get the detail of a conversion by ID.
GET
/v1/affiliates/reporting/conversions/:conversionId
Get the click report.
POST
/v1/affiliates/reporting/clicks
Get a list of raw click files.
POST
/v1/affiliates/reporting/raw/clicks
Get the click report stream
POST
/v1/affiliates/reporting/clicks/stream
Get the detail of a click by transaction ID.
GET
/v1/affiliates/reporting/clicks/:transactionId

Get a sub id report

POST
/v1/affiliates/reporting/sub/:subVariable
Description

This endpoint allows you to retrieve a report by sub.

The number of requests per hour for this endpoint is likely to be limited. Read more about quotas in User Guide > Rate Limiting > BigQuery Quotas.

Path Parameters
subVariable
A sub variable, values are sub1-5
Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get a daily report

POST
/v1/affiliates/reporting/daily
Description

This endpoint lists all daily reports for a given time interval.

Please note that this report is limited to 10,000 rows. If you hit the limit, response will include "incomplete_results": true in the payload.

Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get an offer report

POST
/v1/affiliates/reporting/offer
Description

This endpoint list the reporting of your offers for a given time interval.

Please note that the table portion is limited to 10,000 rows. If you hit the limit, response will include "incomplete_results": true in the payload.

Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get report based on specified entity.

POST
/v1/affiliates/reporting/entity
Description

Access a custom reporting based on one or up to 5 column types. Column selection is mandatory for this endpoint and allowed values are listed below. Filters and settings can be used to narrow down the search.

This endpoint allow grouping by categories and subcategories. For example, to get a report that details performance for every offer, select column offer. To get a more precise understanding of offer performance by week, select columns offer and country. This will generate reporting for every offer-country combination. Can be used in combination with filters.

This endpoint outputs these 3 distinct objects :

  • Table : This object is the reporting itself split in desired categories
  • Performance : Breaks the result into timestamp division. Useful to print a graph of the performance relative to time.
  • Summary : Aggregates the result of each metric into one value for the time period.

The number of requests per hour for this endpoint is likely to be limited. Read more about quotas in User Guide > Rate Limiting > BigQuery Quotas.

Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get the conversion report.

POST
/v1/affiliates/reporting/conversions
Description

This endpoint lists all conversions for a given time interval.

Filters can be used to narrow down the search.

This endpoint returns a paginated response. Read more about paging in Everflow API > Paging section.

Results are limited to 2000 entries per page.

Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get the detail of a conversion by ID.

GET
/v1/affiliates/reporting/conversions/:conversionId
Description

This endpoint allows you to retrieve a Conversion by ID.

Returns HTTP code 404 if the Conversion doesn't exist.

Path Parameters
conversionId
The ID of a Conversion
Response Schema
Tree View
JSON
Response
object

Get the click report.

POST
/v1/affiliates/reporting/clicks
Description

This endpoint lists all clicks for a given time interval.

Results are limited to 1000 clicks and 14 days interval. Use the click report stream to get more results (5000 clicks).

Filters can be used to narrow down the search.

The number of requests per hour for this endpoint is likely to be limited. Read more about quotas in User Guide > Rate Limiting > BigQuery Quotas.

Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get a list of raw click files.

POST
/v1/affiliates/reporting/raw/clicks
Description

This endpoint lists all raw clicks for a given time interval.

Results are limited to 1000 clicks and 14 days interval. Use the click report stream to get more results.

Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get the click report stream

POST
/v1/affiliates/reporting/clicks/stream
Description

This endpoint lists all clicks for a given time interval.

Results are limited to 5 000 clicks and 14 days interval.

Filters can be used to narrow down the search.

The number of requests per hour for this endpoint is likely to be limited. Read more about quotas in User Guide > Rate Limiting > BigQuery Quotas.

Request Body
Tree View
JSON
Body
object
Response Schema
Tree View
JSON
Response
object

Get the detail of a click by transaction ID.

GET
/v1/affiliates/reporting/clicks/:transactionId
Description

This endpoint allows you to retrieve a click by transaction Id.

Returns HTTP code 400 if the click doesn't exist.

The number of requests per hour for this endpoint is likely to be limited. Read more about quotas in User Guide > Rate Limiting > BigQuery Quotas.

Path Parameters
transactionId
The ID of a Transaction
Response Schema
Tree View
JSON
Response
object