Get Offer by ID

GET /networks/offers/{offerId}

Get Offer by ID

cURL

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

200

{
  "network_offer_id": 123,
  "network_id": 123,
  "network_advertiser_id": 123,
  "network_offer_group_id": 123,
  "name": "<string>",
  "offer_status": "active",
  "thumbnail_url": "<string>",
  "visibility": "public",
  "currency_id": "<string>",
  "destination_url": "<string>",
  "server_side_url": "<string>",
  "preview_url": "<string>",
  "html_description": "<string>",
  "internal_notes": "<string>",
  "network_category_id": 123,
  "project_id": "<string>",
  "date_live_until": "<string>",
  "conversion_method": "server_postback",
  "redirect_mode": "standard",
  "session_definition": "cookie",
  "session_duration": 123,
  "attribution_method": "first_touch",
  "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_revenue_cap": 123,
  "weekly_revenue_cap": 123,
  "monthly_revenue_cap": 123,
  "global_revenue_cap": 123,
  "daily_click_cap": 123,
  "weekly_click_cap": 123,
  "monthly_click_cap": 123,
  "global_click_cap": 123,
  "is_use_scrub_rate": true,
  "scrub_rate_percentage": 123,
  "is_duplicate_filter_enabled": true,
  "is_block_already_converted": true,
  "is_use_secure_link": true,
  "is_allow_deep_link": true,
  "is_session_tracking_enabled": true,
  "session_tracking_lifespan_hour": 123,
  "session_tracking_minimum_lifespan_second": 123,
  "session_tracking_start_on": "null_value",
  "is_whitelist_check_enabled": true,
  "is_using_suppression_list": true,
  "suppression_list_id": 123,
  "network_tracking_domain_id": 123,
  "caps_timezone_id": 123,
  "app_identifier": "<string>",
  "is_description_plain_text": true,
  "terms_and_conditions": "<string>",
  "is_force_terms_and_conditions": true,
  "is_using_explicit_terms_and_conditions": true,
  "redirect_routing_method": "unknown",
  "redirect_internal_routing_type": "unknown",
  "scrub_rate_status": "rejected",
  "duplicate_filter_targeting_action": "unknown",
  "already_converted_action": "unknown",
  "is_must_approve_conversion": true,
  "is_allow_duplicate_conversion": true,
  "is_use_direct_linking": true,
  "is_seo_friendly": true,
  "is_fail_traffic_enabled": true,
  "is_view_through_enabled": true,
  "is_view_through_session_tracking_enabled": true,
  "view_through_destination_url": "<string>",
  "view_through_session_tracking_lifespan_minute": 123,
  "view_through_session_tracking_minimal_lifespan_second": 123,
  "is_email_attribution_enabled": true,
  "is_email_attribution_window_enabled": true,
  "email_attribution_method": "first_affiliate_attribution",
  "email_attribution_window_minute": 123,
  "email_attribution_window_type": "static",
  "is_soft_cap": true,
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "advertiser": {
      "network_advertiser_id": 123,
      "network_id": 123,
      "name": "<string>",
      "account_status": "<string>",
      "network_employee_id": 123,
      "internal_notes": "<string>",
      "address_id": 123,
      "is_contact_address_enabled": true,
      "sales_manager_id": 123,
      "is_expose_publisher_reporting_data": true,
      "default_currency_id": "<string>",
      "platform_name": "<string>",
      "platform_url": "<string>",
      "platform_username": "<string>",
      "reporting_timezone_id": 123,
      "accounting_contact_email": "<string>",
      "verification_token": "<string>",
      "offer_id_macro": "<string>",
      "affiliate_id_macro": "<string>",
      "time_created": 1734455015,
      "time_saved": 1734455015,
      "attribution_method": "<string>",
      "email_attribution_method": "<string>",
      "attribution_priority": "<string>"
    },
    "category": {
      "network_category_id": 123,
      "network_id": 123,
      "name": "<string>",
      "status": "<string>",
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "creatives": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "traffic_filters": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "labels": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "payout_revenue": {
      "total": 123,
      "entries": [
        {
          "network_offer_payout_revenue_id": 123,
          "network_id": 123,
          "network_offer_id": 123,
          "entry_name": "<string>",
          "payout_type": "<string>",
          "payout_amount": 123,
          "payout_percentage": 123,
          "revenue_type": "<string>",
          "revenue_amount": 123,
          "revenue_percentage": 123,
          "is_default": true,
          "is_private": true,
          "is_postback_disabled": true,
          "is_enforce_caps": true,
          "time_created": 1734455015,
          "global_advertiser_event_id": 123,
          "is_must_approve_conversion": true,
          "is_allow_duplicate_conversion": true,
          "is_email_attribution_default_event": true,
          "remote_offer_resource": {
            "network_offer_id": 123,
            "network_id": 123,
            "resource_type": "<string>",
            "remote_resource_id": "<string>",
            "resource_id": 123,
            "last_value_md5": "<string>",
            "json_config": "<string>",
            "json_data": "<string>",
            "time_created": 1734455015,
            "time_saved": 1734455015
          }
        }
      ]
    },
    "custom_cap_settings": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "custom_scrub_rate_settings": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "custom_payout_revenue_settings": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "reporting": {
      "imp": 123,
      "total_click": 123,
      "unique_click": 123,
      "invalid_click": 123,
      "duplicate_click": 123,
      "gross_click": 123,
      "ctr": 123,
      "cv": 123,
      "invalid_cv_scrub": 123,
      "view_through_cv": 123,
      "total_cv": 123,
      "event": 123,
      "cvr": 123,
      "evr": 123,
      "cpc": 123,
      "cpm": 123,
      "cpa": 123,
      "epc": 123,
      "rpc": 123,
      "rpa": 123,
      "rpm": 123,
      "payout": 123,
      "revenue": 123,
      "event_revenue": 123,
      "gross_sales": 123,
      "profit": 123,
      "margin": 123,
      "roas": 123,
      "avg_sale_value": 123,
      "media_buying_cost": 123,
      "on_hold_potential_revenue": 123,
      "on_hold_potential_payout": 123,
      "on_hold_conversion_count": 123,
      "public_events": 123
    },
    "audits": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "visibility": {
      "network_id": 123,
      "network_offer_id": 123,
      "network_affiliate_visible_ids": [
        123
      ],
      "network_affiliate_rejected_ids": [
        123
      ],
      "network_affiliate_hidden_ids": [
        123
      ]
    },
    "integrations": {
      "optizmo": {},
      "twentyfour_metrics": {},
      "offer_demand_partner": {},
      "forensiq": {},
      "ezepo": {},
      "anura": {},
      "invoca": {},
      "ip_quality_score": {},
      "unsubcentral": {},
      "ringba": {},
      "retreaver": {}
    },
    "ruleset": {
      "network_id": 123,
      "network_ruleset_id": 123,
      "time_created": 1734455015,
      "time_saved": 1734455015,
      "platforms": [
        {}
      ],
      "device_types": [
        {}
      ],
      "os_versions": [
        {}
      ],
      "browsers": [
        {}
      ],
      "languages": [
        {}
      ],
      "countries": [
        {}
      ],
      "regions": [
        {}
      ],
      "cities": [
        {}
      ],
      "dmas": [
        {}
      ],
      "mobile_carriers": [
        {}
      ],
      "connection_types": [
        {}
      ],
      "ips": [
        {}
      ],
      "is_block_proxy": true,
      "is_use_day_parting": true,
      "day_parting_apply_to": "<string>",
      "day_parting_timezone_id": 123,
      "days_parting": [
        {}
      ],
      "isps": [
        {}
      ],
      "brands": [
        {}
      ],
      "postal_codes": [
        {}
      ]
    },
    "source_names": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "urls": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "encoded_value": "<string>",
    "remaining_caps": {
      "remaining_daily_payout_cap": 123,
      "remaining_daily_revenue_cap": 123,
      "remaining_daily_conversion_cap": 123,
      "remaining_daily_click_cap": 123,
      "remaining_weekly_payout_cap": 123,
      "remaining_weekly_revenue_cap": 123,
      "remaining_weekly_conversion_cap": 123,
      "remaining_weekly_click_cap": 123,
      "remaining_monthly_payout_cap": 123,
      "remaining_monthly_revenue_cap": 123,
      "remaining_monthly_conversion_cap": 123,
      "remaining_monthly_click_cap": 123,
      "remaining_global_payout_cap": 123,
      "remaining_global_revenue_cap": 123,
      "remaining_global_conversion_cap": 123,
      "remaining_global_click_cap": 123
    },
    "is_locked_currency": true,
    "is_locked_caps_timezone": true,
    "is_dmo": true,
    "custom_creative_settings": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "channels": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "affiliate_tier_infos": [
      {}
    ],
    "thumbnail_asset": {},
    "suppression_file_asset": {},
    "campaigns": [
      {}
    ],
    "advertiser_global_events": [
      {}
    ],
    "email": {},
    "email_optout": {},
    "application_questionnaire": {},
    "network_application_questionnaire_id": 123,
    "offer_group": {},
    "internal_redirects": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "meta": {
      "network_offer_id": 123,
      "network_id": 123,
      "app_id": "<string>",
      "meta_platform": "<string>",
      "advertiser_campaign_name": "<string>",
      "bundle_id": "<string>",
      "category": "<string>",
      "store_url": "<string>",
      "score_rating": 123,
      "total_rating": 123,
      "size": 123,
      "developer": "<string>",
      "version": "<string>",
      "is_app_unavailable": true,
      "time_created": 1734455015,
      "time_app_data_saved": 1734455015,
      "time_saved": 1734455015
    },
    "requirement_kpis": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "requirement_tracking_parameters": {
      "total": 123,
      "entries": [
        {}
      ]
    }
  }
}

Retrieve a single offer by its ID with full configuration details. Use the relationship query parameter to include related data such as advertiser, visibility, payout_revenue, urls, ruleset, targeting, and more.

Authorizations

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

The Everflow API key generated from the Control Center > Security.

Path Parameters

offerId · integer · required

The unique offer ID.

Query Parameters

relationship · enum<string>

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

Available options: 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

Response

200

application/json

network_offer_id · integer

Unique offer ID.

network_id · integer

network_advertiser_id · integer

Advertiser that owns this offer.

network_offer_group_id · integer

Offer group ID.

name · string

Offer name.

offer_status · enum<string>

Available options: active, paused, pending, deleted

thumbnail_url · string

visibility · enum<string>

Available options: public, require_approval, private

currency_id · string

destination_url · string

Destination URL for the offer.

server_side_url · string

Server-side postback URL.

preview_url · string

html_description · string

HTML description of the offer.

internal_notes · string

Internal notes (not visible to affiliates).

network_category_id · integer

project_id · string

date_live_until · string

Offer expiration date (YYYY-MM-DD).

conversion_method · enum<string>

Available options: server_postback, http_image_pixel, https_image_pixel, http_iframe_pixel, https_iframe_pixel, javascript, cookie_based, html_pixel_cookie_based

redirect_mode · enum<string>

Available options: standard, single_meta_refresh, double_meta_refresh, seo_friendly

session_definition · enum<string>

Available options: cookie, ip, ip_user_agent, google_ad_id, idfa

session_duration · integer

Session duration in hours.

attribution_method · enum<string>

Available options: first_touch, last_touch

is_caps_enabled · boolean

daily_conversion_cap · integer

weekly_conversion_cap · integer

monthly_conversion_cap · integer

global_conversion_cap · integer

daily_payout_cap · integer

weekly_payout_cap · integer

monthly_payout_cap · integer

global_payout_cap · integer

daily_revenue_cap · integer

weekly_revenue_cap · integer

monthly_revenue_cap · integer

global_revenue_cap · integer

daily_click_cap · integer

weekly_click_cap · integer

monthly_click_cap · integer

global_click_cap · integer

is_use_scrub_rate · boolean

scrub_rate_percentage · integer

is_duplicate_filter_enabled · boolean

is_block_already_converted · boolean

is_use_secure_link · boolean

is_allow_deep_link · boolean

is_session_tracking_enabled · boolean

session_tracking_lifespan_hour · integer

session_tracking_minimum_lifespan_second · integer

session_tracking_start_on · enum<string>

Available options: null_value, first_click, every_click

is_whitelist_check_enabled · boolean

is_using_suppression_list · boolean

suppression_list_id · integer

network_tracking_domain_id · integer

caps_timezone_id · integer

app_identifier · string

is_description_plain_text · boolean

terms_and_conditions · string

is_force_terms_and_conditions · boolean

is_using_explicit_terms_and_conditions · boolean

redirect_routing_method · enum<string>

Available options: unknown, internal, null_value

redirect_internal_routing_type · enum<string>

Available options: unknown, priority, weight, null_value, priority_global, weight_global

scrub_rate_status · enum<string>

Available options: rejected, pending

duplicate_filter_targeting_action · enum<string>

Available options: unknown, block, fail_traffic

already_converted_action · enum<string>

Available options: unknown, block, fail_traffic

is_must_approve_conversion · boolean

is_allow_duplicate_conversion · boolean

is_use_direct_linking · boolean

is_seo_friendly · boolean

is_fail_traffic_enabled · boolean

is_view_through_enabled · boolean

is_view_through_session_tracking_enabled · boolean

view_through_destination_url · string

view_through_session_tracking_lifespan_minute · integer

view_through_session_tracking_minimal_lifespan_second · integer

is_email_attribution_enabled · boolean

is_email_attribution_window_enabled · boolean

email_attribution_method · enum<string>

Available options: first_affiliate_attribution, last_affiliate_attribution

email_attribution_window_minute · integer

email_attribution_window_type · enum<string>

Available options: static, dynamic

is_soft_cap · boolean

time_created · integer

Example:

1734455015

time_saved · integer

Example:

1734455015

relationship · object

Related data returned with the offer.

Show child attributes