FlexOffers.com has hundreds of thousands of Links in our system and more Links are added every day. Requesting Links is typically the primary use case for our users.

Please note that all of our Date and DateTime values are serialized into ISO8601 standard format (http://www.iso.org/iso/home/standards/iso8601.htm)

When accessed through the REST API, we expose the following fields for each Link:

Product ID – Our proprietary identification number for the product that the Link is associated with
Content Type – Specifies whether the Link is a Banner or a Text Link
Categories – Some Links are grouped into particular categories. This field will provide a list of categories the Link belongs to. Some examples are “Apparel”, “Automotive”, and “Office Supplies”.
Link Text – Contains the Link’s text-based content (if any)
Advertiser ID – Our proprietary identification number for the Advertiser associated with the Link
Advertiser – The name of the Advertiser associated with the Link
Advertiser Logo – A URL directing to an image (if any) of the logo of the Advertiser associated with the Link
Banner URL – A URL directing to an image (if any) of the banner associated with the Link
Link URL – A URL directing to the target of the Link which carries our tracking information
HTML Code – HTML representation of the Link that includes its content (banner or text)
Banner ID – Our proprietary identification number for the Banner (if any) associated with the Link. If the Link is not a Banner, then its Banner ID is set to ‘0’.
Banner Type – The type of Banner associated with a Link (e.g., Button, Full Banner, etc.)
Banner Type ID – Our proprietary identification number for the Banner Type (if any). If the Link is not a Banner, then its Banner Type ID is set to ‘null’.
Banner Height – Contains the Link’s banner height if is a banner, otherwise the value is zero.
Banner Width – Contains the Link’s banner width if is a banner, otherwise the value is zero.
Last Modified Date – The date and time that the Link was last modified (Serialized in ISO8601 format)
Active Date – The date that the Link will – or had – become active (Serialized in ISO8601 format)
Expire Date – The date that the Link will – or had – become expired (Serialized in ISO8601 format)
EPC 7D – The $USD earnings per 1,000 clicks averaged over 7 days. This value has not been calculated for some links, in which case the field yields “null”.
EPC 3M – The $USD earnings per 1,000 clicks averaged over 3 months. This value has not been calculated for some links, in which case the field yields “null”.
Allows Deep Linking – Offers that allow deep linking allow you to set a specific destination page that browsers will be redirected to when the offer is clicked. For example, you may want the offer to go to a specific product page.
Coupon Code – If the Link represents a promotional coupon, this field contains the promotion’s coupon code
Restrictions – Any terms or guidelines imposed upon the Link
Promotion Types – Some links are grouped into Promotion Types. This field will provide a list of promotion types associated with the Link, such as “Coupon” or “Free Shipping”.

Categories

This endpoint lists all active categories along with their parent categories for products that have been approved for your domain and are currently active.

Results are grouped by parent category and the following fields are listed for each category:

id – Our proprietary identification number for the category / parent category
name – The name of the category / parent category
subCategories – Contains a list of the categories associated with approved products and are children of the current category
isDisabled – Returns “True” if the category has been temporarily disabled, “False” otherwise
isDeleted – Returns “True” if the category has been deleted, “False” otherwise

Advertisers

This endpoint lists all active programs your domain has been approved for

The following fields are listed in each program:

id – Our proprietary identification number for the program
name – The name of the program
domainUrl – The advertiser’s URL
categoryIds – This is a list of category ids associated with the program
applicationStatus – The status of your application to the program
applicationStatusId – Our proprietary identification number for program’s status
description – A description of the advertiser, and it’s products
payout – Contains a description of the expected payout rate.
imageUrl – A URL directing to the Advertiser’s logo

Promotion Types

This endpoint lists all active promotion types that can be applied to products

The following fields are listed in each promotion type:

id – Our proprietary identification number for the promotion type
name – The name of the promotion type

This endpoint lists all active banner types that can be applied to products or programs

The following fields are listed in each banner type:

id – Our proprietary identification number for the banner type
name – A short description of the banner type, usually specifying the dimensions in pixels
width – The width of the banner type, in pixels
height – The height of the banner type, in pixels

Campaigns

This endpoint lists all active campaigns for which your domain has been approved

The following fields are listed in each campaign:

name – The name of the campaign
code – An auto generated number that is passed as a parameter to the link to allow tracking sales by campaign
dateCreated – The date and time the campaign was created (Serialized in ISO8601 format)

Sales

transactionCode – Our proprietary identification number for the transaction that originated the sale
categoryId – Our proprietary identification number for the category assigned to the product sold
categoryName – The name of the category assigned to the product sold
productId – Our proprietary identification number for the product associated with the link that originated the sale
productName – A description of the product sold
domainId – Our proprietary identification number indicating your domain
domainName – Your domain’s name
accountId – Our proprietary identification number for the account associated with your domain
tracking – Our proprietary identification number indicating which campaign is associated with the link that originated the sale
subTracking – Optional code added to the link by the publisher by using the query parameter “&fobs”
transactionDate – The date and time the transaction was created (i.e. when the click took place) (Serialized in ISO8601 format)
amount – The sale’s commission paid to the publisher
clickId – Our proprietary identification number for the click that originated the sale
clickDate – The date and time of the click that originated the sale as informed by the advertiser (Serialized in ISO8601 format)
orderNumber – The advertiser’s proprietary identification number associated with the sale’s order
orderStatus – The status of the sale’s order as informed by the advertiser. For Sales reports this is always set to “Approved”
merchantAmount – The amount of the original sale as informed by the advertiser. A zero value indicates the advertiser didn’t provide the actual amount
id – Our proprietary identification number for the original action that generated the sale (i.e. click)


Would you like to learn more?