v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Affiliate Offers

Find Offer By ID

get/affiliates/offers/{offerId}

Path parameters

offerIdinteger required

The numeric ID of the offer.

Response

network_offer_idinteger

Unique identifier for the offer.

network_idinteger

Network ID.

namestring

Offer name.

offer_statusstring

Current status of the offer.

currency_idstring

Currency code for the offer.

visibilitystring

Visibility setting of the offer.

html_descriptionstring

Offer description in HTML format.

is_description_plain_textboolean

Whether the description is plain text or HTML.

preview_urlstring

Preview URL for the offer landing page.

tracking_urlstring

Base tracking URL.

redirect_tracking_urlstring

Redirect tracking URL.

impression_tracking_urlstring

Impression tracking URL.

thumbnail_urlstring

URL of the offer thumbnail image.

network_category_idinteger

Category ID for the offer.

is_caps_enabledboolean

Whether caps are enabled for this offer.

caps_timezone_idinteger

Timezone ID used for cap calculations.

daily_conversion_capinteger

Daily conversion cap.

weekly_conversion_capinteger

Weekly conversion cap.

monthly_conversion_capinteger

Monthly conversion cap.

global_conversion_capinteger

Global (lifetime) conversion cap.

daily_click_capinteger

Daily click cap.

weekly_click_capinteger

Weekly click cap.

monthly_click_capinteger

Monthly click cap.

global_click_capinteger

Global (lifetime) click cap.

daily_payout_capnumber

Daily payout cap.

weekly_payout_capnumber

Weekly payout cap.

monthly_payout_capnumber

Monthly payout cap.

global_payout_capnumber

Global (lifetime) payout cap.

is_force_terms_and_conditionsboolean

Whether terms and conditions acceptance is required.

is_using_explicit_terms_and_conditionsboolean

Whether the offer uses explicit terms and conditions.

terms_and_conditionsstring

Terms and conditions text.

is_use_direct_linkingboolean

Whether direct linking is enabled.

is_using_suppression_listboolean

Whether a suppression list is in use.

suppression_list_idinteger

Suppression list ID.

network_tracking_domain_idinteger

Tracking domain ID.

app_identifierstring

App store identifier for mobile offers.

date_live_untilstring

Date until which the offer is live.

time_createdinteger

Timestamp when the offer was created.

time_savedinteger

Timestamp when the offer was last saved.