Get Offer

GET /partners/offers/{networkId}/{offerId}

Get Offer By ID

cURL

curl --request GET \
  --url https://api.eflow.team/v1/partners/offers/{networkId}/{offerId} \
  --header 'X-Eflow-Api-Key: <api-key>'

200

{
  "network_offer_id": 123,
  "network_id": 123,
  "name": "<string>",
  "offer_status": "active",
  "thumbnail_url": "<string>",
  "network_category_id": 123,
  "preview_url": "<string>",
  "currency_id": "<string>",
  "html_description": "<string>",
  "visibility": "public",
  "is_caps_enabled": true,
  "daily_conversion_cap": 123,
  "weekly_conversion_cap": 123,
  "monthly_conversion_cap": 123,
  "global_conversion_cap": 123,
  "daily_payout_cap": 123,
  "weekly_payout_cap": 123,
  "monthly_payout_cap": 123,
  "global_payout_cap": 123,
  "daily_click_cap": 123,
  "weekly_click_cap": 123,
  "monthly_click_cap": 123,
  "global_click_cap": 123,
  "tracking_url": "<string>",
  "impression_tracking_url": "<string>",
  "redirect_tracking_url": "<string>",
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "app_identifier": "<string>",
  "caps_timezone_id": 123,
  "date_live_until": "<string>",
  "is_description_plain_text": true,
  "is_force_terms_and_conditions": true,
  "is_use_direct_linking": true,
  "is_using_explicit_terms_and_conditions": true,
  "is_using_suppression_list": true,
  "network_tracking_domain_id": 123,
  "suppression_list_id": 123,
  "terms_and_conditions": "<string>",
  "relationship": {
    "blocked_variables_count": 123,
    "category": {
      "network_category_id": 123,
      "network_id": 123,
      "name": "<string>",
      "status": "<string>",
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "channels": {
      "entries": [
        {
          "network_channel_id": 123,
          "network_id": 123,
          "name": "<string>",
          "status": "<string>",
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ],
      "total": 123
    },
    "creative_bundle": {
      "url": "<string>"
    },
    "creatives": {
      "entries": [
        {
          "network_offer_creative_id": 123,
          "network_id": 123,
          "network_offer_id": 123,
          "name": "<string>",
          "creative_type": "<string>",
          "creative_status": "<string>",
          "width": 123,
          "height": 123,
          "resource_url": "<string>",
          "html_code": "<string>",
          "is_private": true,
          "is_apply_specific_affiliates": true,
          "email_subject": "<string>",
          "email_subject_lines": "<string>",
          "email_from": "<string>",
          "email_from_lines": "<string>",
          "additional_offer_ids": "<string>",
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ],
      "total": 123
    },
    "custom_payout_settings": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "email": {
      "network_id": 123,
      "network_offer_id": 123,
      "is_enabled": true,
      "from_lines": "<string>",
      "subject_lines": "<string>"
    },
    "email_optout": {
      "network_id": 123,
      "network_offer_id": 123,
      "is_enabled": true,
      "unsub_link": "<string>",
      "suppression_file_link": "<string>"
    },
    "integrations": {
      "invoca": {
        "enabled": true
      },
      "retreaver": {},
      "ringa": {},
      "ezepo": {},
      "optizmo": {},
      "unsubcentral": {}
    },
    "meta": {
      "network_id": 123,
      "network_offer_id": 123,
      "meta_platform": "<string>",
      "app_id": "<string>",
      "bundle_id": "<string>",
      "store_url": "<string>",
      "category": "<string>",
      "developer": "<string>",
      "version": "<string>",
      "size": "<string>",
      "score_rating": 123,
      "total_rating": 123,
      "advertiser_campaign_name": "<string>",
      "is_app_unavailable": true,
      "time_app_data_saved": 1734455015,
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "network": {
      "network_id": 123,
      "displayed_name": "<string>"
    },
    "offer_affiliate_status": "<string>",
    "payouts": {
      "entries": [
        {
          "network_offer_payout_revenue_id": 123,
          "entry_name": "<string>",
          "payout_type": "<string>",
          "payout_amount": 123,
          "payout_percentage": 123,
          "is_default": true,
          "is_enforce_caps": true,
          "is_postback_disabled": true,
          "network_custom_payout_revenue_setting_id": 123,
          "custom_payout_overwrite": {}
        }
      ],
      "total": 123
    },
    "remaining_caps": {
      "remaining_daily_conversion_cap": 123,
      "remaining_daily_payout_cap": 123,
      "remaining_daily_click_cap": 123
    },
    "reporting": {
      "imp": 123,
      "total_click": 123,
      "unique_click": 123,
      "duplicate_click": 123,
      "invalid_click": 123,
      "cv": 123,
      "event": 123,
      "view_through_cv": 123,
      "ctr": 123,
      "cvr": 123,
      "evr": 123,
      "revenue": 123,
      "rpc": 123,
      "rpm": 123,
      "on_hold_conversion_count": 123,
      "on_hold_potential_revenue": 123,
      "redirect_traffic_revenue": 123
    },
    "requirement_kpis": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "requirement_tracking_parameters": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "ruleset": {
      "network_ruleset_id": 123,
      "network_id": 123,
      "is_block_proxy": true,
      "is_use_day_parting": true,
      "day_parting_apply_to": "<string>",
      "day_parting_timezone_id": 123,
      "days_parting": [
        {}
      ],
      "countries": [
        {}
      ],
      "regions": [
        {}
      ],
      "cities": [
        {}
      ],
      "dmas": [
        {}
      ],
      "postal_codes": [
        {}
      ],
      "ips": [
        {}
      ],
      "platforms": [
        {
          "network_targeting_platform_id": 123,
          "network_id": 123,
          "platform_id": 123,
          "label": "<string>",
          "match_type": "<string>",
          "targeting_type": "<string>"
        }
      ],
      "os_versions": [
        {
          "network_targeting_os_version_id": 123,
          "network_id": 123,
          "os_version_id": 123,
          "platform_id": 123,
          "label": "<string>",
          "match_type": "<string>",
          "targeting_type": "<string>"
        }
      ],
      "browsers": [
        {
          "network_targeting_browser_id": 123,
          "network_id": 123,
          "browser_id": 123,
          "label": "<string>",
          "match_type": "<string>",
          "targeting_type": "<string>"
        }
      ],
      "device_types": [
        {
          "network_targeting_device_type_id": 123,
          "network_id": 123,
          "device_type_id": 123,
          "label": "<string>",
          "match_type": "<string>",
          "targeting_type": "<string>"
        }
      ],
      "brands": [
        {}
      ],
      "languages": [
        {
          "network_targeting_browser_language_id": 123,
          "network_id": 123,
          "browser_language_id": 123,
          "label": "<string>",
          "match_type": "<string>",
          "targeting_type": "<string>"
        }
      ],
      "mobile_carriers": [
        {}
      ],
      "connection_types": [
        {}
      ],
      "isps": [
        {}
      ],
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "suppression_file_asset": {
      "network_asset_id": 123,
      "filename": "<string>",
      "url": "<string>",
      "content_type": "<string>",
      "file_size": 123,
      "image_width": 123,
      "image_height": 123,
      "optimized_thumbnail_url": "<string>"
    },
    "thumbnail_asset": {
      "network_asset_id": 123,
      "filename": "<string>",
      "url": "<string>",
      "content_type": "<string>",
      "file_size": 123,
      "image_width": 123,
      "image_height": 123,
      "optimized_thumbnail_url": "<string>"
    },
    "today_revenue": "<string>",
    "urls": {
      "entries": [
        {
          "network_offer_url_id": 123,
          "network_id": 123,
          "network_offer_id": 123,
          "name": "<string>",
          "preview_url": "<string>"
        }
      ],
      "total": 123
    }
  }
}

Retrieve a specific offer by its network ID and offer ID. Returns the full offer object with all relationship data.

Authorizations

X-Eflow-Api-Key · string · header · required

The marketplace partner's API key. Uses the X-Eflow-Api-Key header. The key belongs to the marketplace partner user.

Path Parameters

networkId · integer · required

The network ID that owns the offer.

offerId · integer · required

The unique offer ID.

Query Parameters

relationship · enum<string>

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

Available options: category, creatives, reporting, payouts, ruleset, urls, channels, creative_bundle, remaining_caps, custom_payout_settings

Response

200

application/json

network_offer_id · integer

Unique offer ID.

network_id · integer

Network ID that owns this offer.

name · string

Offer name.

offer_status · enum<string>

Current status of the offer.

Available options: active, paused, pending, deleted

thumbnail_url · string

Offer thumbnail image URL.

network_category_id · integer

Category ID for the offer.

preview_url · string

Preview URL for the offer landing page.

currency_id · string

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

html_description · string

HTML description of the offer.

visibility · enum<string>

Offer visibility setting.

Available options: public, require_approval, private

is_caps_enabled · boolean

Whether caps are enabled for this offer.

daily_conversion_cap · integer

Maximum conversions allowed per day. 0 means unlimited.

weekly_conversion_cap · integer

Maximum conversions allowed per week. 0 means unlimited.

monthly_conversion_cap · integer

Maximum conversions allowed per month. 0 means unlimited.

global_conversion_cap · integer

Maximum total conversions allowed. 0 means unlimited.

daily_payout_cap · integer

Maximum payout amount per day. 0 means unlimited.

weekly_payout_cap · integer

Maximum payout amount per week. 0 means unlimited.

monthly_payout_cap · integer

Maximum payout amount per month. 0 means unlimited.

global_payout_cap · integer

Maximum total payout amount. 0 means unlimited.

daily_click_cap · integer

Maximum clicks allowed per day. 0 means unlimited.

weekly_click_cap · integer

Maximum clicks allowed per week. 0 means unlimited.

monthly_click_cap · integer

Maximum clicks allowed per month. 0 means unlimited.

global_click_cap · integer

Maximum total clicks allowed. 0 means unlimited.

tracking_url · string

The click tracking URL used to route traffic.

impression_tracking_url · string

URL for tracking impressions.

redirect_tracking_url · string

URL for redirect-based tracking.

time_created · integer

Unix timestamp of when the offer was created.

Example:

1734455015

time_saved · integer

Unix timestamp of the last update to the offer.

Example:

1734455015

app_identifier · string

App identifier.

caps_timezone_id · integer

Timezone ID for cap calculations.

date_live_until · string

Offer expiration date (empty string if none).

is_description_plain_text · boolean

Whether description is plain text.

is_force_terms_and_conditions · boolean

Whether terms acceptance is forced.

is_use_direct_linking · boolean

Whether direct linking is allowed.

is_using_explicit_terms_and_conditions · boolean

Whether offer has explicit terms and conditions.

is_using_suppression_list · boolean

Whether offer uses suppression list.

network_tracking_domain_id · integer

Tracking domain ID.

suppression_list_id · integer

Suppression list ID (0 if none).

terms_and_conditions · string

Terms and conditions text.

relationship · object

Related data included in the response. The list endpoint and single-offer endpoint return slightly different default relationship keys.

Show child attributes