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
Offers
Get all visible offers details.
GET
/v1/affiliates/alloffers
Get all runnable offers.
GET
/v1/affiliates/offersrunnable
Get the details of an offer by ID.
GET
/v1/affiliates/offers/:offerId
Get an offer tracking url.
GET
/v1/affiliates/offers/:offerId/url/:urlId
Get an offer impression url.
GET
/v1/affiliates/offers/:offerId/impressionurl/:urlId
Create application for an offer.
POST
/v1/affiliates/offers/:offerId/application
Get a list of all offer/sub ids combinations being blocked
GET
/v1/affiliates/trafficblocking
Get a list of all traffic controls affecting offers (without values)
GET
/v1/affiliates/trafficcontrols
Get all the details related to a specific traffic control (including the values)
GET
/v1/affiliates/trafficcontrols/:controlId
Get a list of all blocked variables as a stream
POST
/v1/affiliates/blockedvariables

Get all visible offers details.

GET
/v1/affiliates/alloffers
Description

This endpoint allows you to retrieve a list of all visible offers. This includes public offers and the ones that require your network's approval.

Returns an empty array if no Offers exist or are visible.

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

Response Schema
Tree View
JSON
Response
object

Get all runnable offers.

GET
/v1/affiliates/offersrunnable
Description

This endpoint allows you to retrieve a list of all runnable offers. This includes public offers and the ones that have gotten your network's approval.

Returns an empty array if no Offers exist or are runnable.

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

Response Schema
Tree View
JSON
Response
object

Get the details of an offer by ID.

GET
/v1/affiliates/offers/:offerId
Description

This endpoint allows you to retrieve a visible Offer by ID.

Returns HTTP code 404 if the Offer doesn't exist or is not visible.

Path Parameters
offerId
The ID of an Offer
Response Schema
Tree View
JSON
Response
object

Get an offer tracking url.

GET
/v1/affiliates/offers/:offerId/url/:urlId
Description

This endpoint lets you pull a tracking link for a runnable Offer by Id.

You can supply 0 for the urlId if no extra destination urls exist or if you do not wish to use one.

Returns HTTP code 404 if the Offer doesn't exist. Returns HTTP code 400 if not allowed to run this Offer.

Path Parameters
offerId
The ID of an Offer
urlId
The id of an extra destination url
Response Schema
Tree View
JSON
Response
object

Get an offer impression url.

GET
/v1/affiliates/offers/:offerId/impressionurl/:urlId
Description

This endpoint lets you pull an impression link for a runnable Offer by Id.

You can supply 0 for the urlId if no extra destination urls exist or if you do not wish to use one.

Returns HTTP code 404 if the Offer doesn't exist. Returns HTTP code 400 if not allowed to run this Offer.

Path Parameters
offerId
The ID of an Offer
urlId
The id of an extra destination url
Response Schema
Tree View
JSON
Response
object

Create application for an offer.

POST
/v1/affiliates/offers/:offerId/application
Description

This endpoint allows you to apply to run an Offer that requires approval. Use offer_id to make application.

Returns HTTP code 400 if the Offer doesn't exist or do not require approval.

Path Parameters
offerId
The ID of an Offer
Response Schema
Tree View
JSON
Response
object

Get a list of all offer/sub ids combinations being blocked

GET
/v1/affiliates/trafficblocking
Description

This endpoint allows you to retrieve a list of all offer/sub combinations that are blocked.

Returns an empty array if no combination exist.

Response Schema
Tree View
JSON
Response
object

Get a list of all traffic controls affecting offers (without values)

GET
/v1/affiliates/trafficcontrols
Description

This endpoint allows you to retrieve a list of all the traffic controls that are affecting your offers.

To retrieve the values, use the endpoint with the spectific traffic control Id.

Returns an empty array if no traffic control exist.

Response Schema
Tree View
JSON
Response
object

Get all the details related to a specific traffic control (including the values)

GET
/v1/affiliates/trafficcontrols/:controlId
Description

This endpoint allows you to retrieve a traffic control, by Id, that is affecting your offers.

Returns HTTP code 404 if the traffic control doesn't exist.

Path Parameters
controlId
Response Schema
Tree View
JSON
Response
object

Get a list of all blocked variables as a stream

POST
/v1/affiliates/blockedvariables
Description

This endpoint list all the variables that are blocking the traffic.

This endpoint includes the values in subs that are blocked at the moment and the ones that were blocked during the selected time interval.

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