Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Advertiser Offers

Get Offer By ID

get/advertisers/offers/{offerId}

Path parameters

offerIdinteger required

The unique offer ID.

Query parameters

relationship'category' | 'creatives' | 'reporting' | 'thumbnail_asset' | 'revenues' | 'ruleset' | 'remaining_caps' | 'meta'

Include related data in the response. Repeat for multiple relationships.

Response

network_offer_idinteger

Unique offer ID.

network_idinteger

Network ID that owns this offer.

namestring

Offer name.

thumbnail_urlstring

Offer thumbnail image URL.

network_category_idinteger

Category ID for the offer.

destination_urlstring

The destination URL where traffic is sent.

preview_urlstring

Preview URL for the offer landing page.

offer_status'active' | 'paused' | 'pending' | 'deleted'

Current status of the offer.

currency_idstring

Currency used for this offer (e.g. "USD").

html_descriptionstring

HTML description of the offer.

visibility'public' | 'require_approval' | 'private'

Offer visibility setting.

caps_timezone_idinteger

Timezone ID used for cap calculations.

date_live_untilstring

Expiration date for the offer (empty string if no expiration).

is_using_explicit_terms_and_conditionsboolean

Whether the offer has explicit terms and conditions.

terms_and_conditionsstring

The offer's terms and conditions text.

is_caps_enabledboolean

Whether caps are enabled for this offer.

is_using_suppression_listboolean

Whether the offer uses a suppression list.

suppression_list_idinteger

ID of the suppression list used (0 if none).

network_tracking_domain_idinteger

ID of the tracking domain used for this offer.

daily_conversion_capinteger

Maximum conversions allowed per day. 0 means unlimited.

weekly_conversion_capinteger

Maximum conversions allowed per week. 0 means unlimited.

monthly_conversion_capinteger

Maximum conversions allowed per month. 0 means unlimited.

global_conversion_capinteger

Maximum total conversions allowed. 0 means unlimited.

daily_revenue_capinteger

Maximum revenue amount per day. 0 means unlimited.

weekly_revenue_capinteger

Maximum revenue amount per week. 0 means unlimited.

monthly_revenue_capinteger

Maximum revenue amount per month. 0 means unlimited.

global_revenue_capinteger

Maximum total revenue amount. 0 means unlimited.

daily_click_capinteger

Maximum clicks allowed per day. 0 means unlimited.

weekly_click_capinteger

Maximum clicks allowed per week. 0 means unlimited.

monthly_click_capinteger

Maximum clicks allowed per month. 0 means unlimited.

global_click_capinteger

Maximum total clicks allowed. 0 means unlimited.

tracking_urlstring

The tracking URL used to route traffic to this offer.

time_createdinteger

Unix timestamp of when the offer was created.

time_savedinteger

Unix timestamp of the last update to the offer.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "category": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "creatives": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    }
  }
}