Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Offers

Get Offer by ID

get/networks/offers/{offerId}

Path parameters

offerIdinteger required

The unique offer ID.

Query parameters

relationship'all' | 'advertiser' | 'application_questionnaire' | 'offer_group' | 'visibility' | 'payout_revenue' | 'custom_cap_settings' | 'custom_scrub_rate_settings' | 'custom_payout_revenue_settings' | 'custom_creative_settings' | 'redirects' | 'traffic_filters' | 'targeting' | 'files' | 'audits' | 'source_name' | 'urls' | 'active_urls' | 'integrations' | 'campaigns' | 'reporting' | 'advertiser_global_events' | 'offer_email' | 'offer_email_optout'

Include related data. Repeat for multiple relationships. Use all to include everything.

Response

network_offer_idinteger

Unique offer ID.

network_idinteger
network_advertiser_idinteger

Advertiser that owns this offer.

network_offer_group_idinteger

Offer group ID.

namestring

Offer name.

offer_status'active' | 'paused' | 'pending' | 'deleted'
thumbnail_urlstring
visibility'public' | 'require_approval' | 'private'
currency_idstring
destination_urlstring

Destination URL for the offer.

server_side_urlstring

Server-side postback URL.

preview_urlstring
html_descriptionstring

HTML description of the offer.

internal_notesstring

Internal notes (not visible to affiliates).

network_category_idinteger
project_idstring
date_live_untilstring

Offer expiration date (YYYY-MM-DD).

conversion_method'server_postback' | 'http_image_pixel' | 'https_image_pixel' | 'http_iframe_pixel' | 'https_iframe_pixel' | 'javascript' | 'cookie_based' | 'html_pixel_cookie_based'
redirect_mode'standard' | 'single_meta_refresh' | 'double_meta_refresh' | 'seo_friendly'
session_definition'cookie' | 'ip' | 'ip_user_agent' | 'google_ad_id' | 'idfa'
session_durationinteger

Session duration in hours.

attribution_method'first_touch' | 'last_touch'
is_caps_enabledboolean
daily_conversion_capinteger
weekly_conversion_capinteger
monthly_conversion_capinteger
global_conversion_capinteger
daily_payout_capinteger
weekly_payout_capinteger
monthly_payout_capinteger
global_payout_capinteger
daily_revenue_capinteger
weekly_revenue_capinteger
monthly_revenue_capinteger
global_revenue_capinteger
daily_click_capinteger
weekly_click_capinteger
monthly_click_capinteger
global_click_capinteger
is_use_scrub_rateboolean
scrub_rate_percentageinteger
is_duplicate_filter_enabledboolean
is_block_already_convertedboolean
is_use_secure_linkboolean
is_allow_deep_linkboolean
is_session_tracking_enabledboolean
session_tracking_lifespan_hourinteger
session_tracking_minimum_lifespan_secondinteger
session_tracking_start_on'null_value' | 'impression' | 'click'
is_whitelist_check_enabledboolean
is_using_suppression_listboolean
suppression_list_idinteger
network_tracking_domain_idinteger
caps_timezone_idinteger
app_identifierstring
is_description_plain_textboolean
terms_and_conditionsstring
is_force_terms_and_conditionsboolean
is_using_explicit_terms_and_conditionsboolean
redirect_routing_method'unknown' | 'internal' | 'null_value'
redirect_internal_routing_type'unknown' | 'priority' | 'weight' | 'null_value' | 'priority_global' | 'weight_global'
scrub_rate_status'rejected' | 'pending'
duplicate_filter_targeting_action'unknown' | 'block' | 'fail_traffic'
already_converted_action'unknown' | 'block' | 'fail_traffic'
is_must_approve_conversionboolean
is_allow_duplicate_conversionboolean
is_use_direct_linkingboolean
is_seo_friendlyboolean
is_fail_traffic_enabledboolean
is_view_through_enabledboolean
is_view_through_session_tracking_enabledboolean
view_through_destination_urlstring
view_through_session_tracking_lifespan_minuteinteger
view_through_session_tracking_minimal_lifespan_secondinteger
is_email_attribution_enabledboolean
is_email_attribution_window_enabledboolean
email_attribution_method'first_affiliate_attribution' | 'last_affiliate_attribution'
email_attribution_window_minuteinteger
email_attribution_window_type'static' | 'dynamic'
is_soft_capboolean
time_createdinteger
time_savedinteger

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "advertiser": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "category": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "payout_revenue": {
      "entries": [
        {
          "time_created": 1734455015,
          "remote_offer_resource": {
            "time_created": 1734455015,
            "time_saved": 1734455015
          }
        }
      ]
    },
    "ruleset": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "meta": {
      "time_created": 1734455015,
      "time_app_data_saved": 1734455015,
      "time_saved": 1734455015
    }
  }
}