NATS For Networks REST Offer Get Details

From TMM Wiki
Jump to navigationJump to search
NATS For Networks
For Affiliates
Automatic SubIDs
Affiliate Stats Dumps
Affiliate Custom Pixels
Affiliate Host and Post
Affiliate Area
Affiliate Account Details
Affiliate Account Change Log
Affiliate Creatives
Affiliate Creatives Search
Affiliate Settings
Affiliate Custom Pixels
Affiliate Linkcodes
Affiliate Linkcode Settings
Affiliate Login History
Affiliate Messages
Affiliate Dashboard
Dashboard Key Statistics
Dashboard Statistics Summary
Affiliate Payment History
Quick Links
Affiliate Referrals Report
Affiliate Referring URL Report
Affiliate Remote Login
Affiliate Signup
Affiliate Statistic Filters
Affiliate Statistic Views
Affiliate SubIDs
NATS For Networks Setup
Creating Admin Accounts
Tracking Domain
Edit Affiliate Text
Edit CSS Colors
Getting Started Admin
Quick Start Guide
Tracking in NATS For Networks
Pixel Builder
Postback Examples
Replacement Variables
Currency Exchange Rates
Admin Dashboard
The Admin Dashboard
Reporting Admin
The Reporting Admin
Track and Strack
  Report Breakdowns
Profit and Loss Report
Subscription Report
Transactions Reports
Affiliate Ratios Report
Affiliate Managers Report
Referral Tier Payouts Report
Referral Signup Payouts Report
Additional Commissions Report
Graphical Affiliate Comparison Report
The Single Day Comparison Report
Actual Affiliate Payments Report
Offers Admin
The Offers Admin
Offer Setup
Affiliate Referrals
Tracking Domain
Commission Changes
Suppression Lists
Pixel Builder
ID Numbers
Offer Partner
Offer/Landing Page Redirection
Setting Rules
Admin Host and Post
Offer Goals
Affiliates Admin
The Affiliates Admin
ID Numbers
Affiliate Managers
Affiliate Referrals
Affiliate Activation
Admin-Only Settings
Affiliate Overrides
Creating Admin Accounts
In-House Accounts
Add Manual Sale
Manual Invoice
Affiliate Documents
Affiliate Enabled Offers
Change Affiliate Status
Account Changes
Advertisers Admin
The Advertisers Admin
Account Changes
Advertiser Invoices
Generate Invoice
Advertiser Approval
Change Advertiser Status
Customers Admin
Customers Admin
Manually Adding a Customer
ID Numbers
Payments Admin
The Payments Admin
Payvia Types
Payout Periods
Payvia Dump Formats
Payment Dump Entry Numbers
Payment Dump Variables
Check Functions
Setting Rules
Payment Methods
API Overview
GET /service/ping
GET /service/set_currency_exchange_rates
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
GET /affiliate/decode_trackingcode
PATCH /affiliate/edit_affiliate
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
GET /config/get_global_void_ips
GET /config/get_global_post_ips
GET /config/get_global_hostnpost_ips
POST /config/add_global_void_ip
POST /config/remove_global_void_ip
POST /config/add_global_post_ip
POST /config/remove_global_post_ip
POST /config/add_global_hostnpost_ip
POST /config/remove_global_hostnpost_ip
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
GET /offer/get_conversion_caps
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
GET /offer/get_details
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
GET /report/profitloss
GET /report/transaction
PATCH /customer/lock
PATCH /customer/unlock
GET /customer/export
PATCH /customer/forget
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash
POST /transaction/process_void
POST /transaction/process_chargeback
POST /transaction/process_reversal
GET /transaction/click_details
Creatives Admin
The Creatives Admin
Add New Creatives
Add New Creative Type
Tracking Code
Code Builder
Track and Strack
Setting Rules
  Default Creative Types
Creative Types
Image Banners
Flash Banners
Dynamic Text Banners
Video Download
Video Embed
Page Peels
IM Popups
Footer Ads
Page Ads
Communications Admin
The Communications Admin
Add News Item
Sending Messages
Signup Questions
Configuration Admin
The Configuration Admin
Affiliate Signup Postback URL
Edit Affiliate Text
Edit CSS Colors
Freeform Date
Affiliate Custom Signup
Tracking Code
Tracking in NATS For Networks
Void Conversions Remotely

GET /offer/get_details


  • API resource to get offer details

Resource URL

  • http://domain/api/offer/get_details
  • Replace domain with the NATS for Networks domain

Request Method

  • GET

Response Format

  • JSON


  • HTTP headers


This API requires either offerid, name, name_like, advertiserid, or advertiser_username. If none are supplied, no results will be returned. If multiple are supplied, only one will be prioritized and used based on the order listed. (ex: if both offerid and name are supplied, only offerid will be used to do the lookup. If name and advertiserid are supplied, only name will be used to do the lookup).

  • offerid
    • type: string
    • optional
    • Offerid or comma separated list of offerids to get details for
  • name
    • type: string
    • optional
    • Exact name of the offer to get details for
  • name_like
    • type: string
    • optional
    • Name fragment of the offer(s) to get details for
  • advertiserid
    • type: int
    • optional
    • Advertiserid to get offers and details for
  • advertiser_username
    • type: string
    • optional
    • Username of advertiser to get offers and details for
  • return_columns
    • type: string
    • allowed values: active, admin_threshold_email, adv_cpm_click, advertiser_username, advertiserid, affiliate_payout, allow_s2s_ip, allowed_hours, allowed_states, approved, authorized_countries, authorized_countries_iso, categories, commission, commission_description, conversion, conversion_cap, conversion_trans_type, continuity, conversion_type, cookie_duration, cost_flat, cost_perc, cost_type, created_by, date_added, date_expire, date_live, deduct_full_customer_commission, deduct_window, deleted, expire_offer, expire_program, expire_url, featured, geoip_group_redirect, groups, hidden, hide_payout_string, ip_conversion_group, ip_conversion_limit, ip_conversion_limit_flag, ip_lookup, ip_uniqueness_seconds, landing_pages, marketing_types, min_deduct_date, mobile_landing_page, name, no_personal_member_info, offer, offer_description, offer_group, offer_limit, offer_limit_addition, offer_limit_deduction, offer_note, offer_quantity, pending_approval_lockout, prevent_cookie_dupes, remove_ocode, reuse_active, revenue_amount, revenue_click, revenue_conversion, revenue_impression, revenue_sale, revenue_type, status, subject_lines, suppress_continuity_pixels, suppress_conversion_pixels, thumb_last_modified, thumbnail_url, timezone, type, unauthorized_countries, unauthorized_countries_iso, unique_duration
    • optional
    • Comma separated list of data columns to return for each offer. "offerid" will always be included in the data for each offer. If no return columns are specified, all details will be returned.
  • start
    • type: int
    • optional
    • If the result set is large, you can use this to start at specific section of the result set.
  • count
    • type: int
    • optional
    • If the result set is large, you can use this to limit how many offers are returned in the result set.

Example Code


$curl = curl_init();

$data = Array(
	'offerid' => '136',
	//'name_like' => 'Offer',
	//'name' => 'API TEST Offer 123',
	'return_columns' => 'name, cost_type, advertiser, advertiser_username, conversion, continuity',

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_details?'.$data_string;

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: productsupport'
curl_setopt($curl, CURLOPT_HTTPGET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
	//json was valid. Dump the decoded array
else {
	//invalid json, just dump the raw response
// Close request to clear up some resources

  • Response:
    [result] => success
    [message] => Offer Found
    [offer_count] => 1
    [offer_details] => Array
            [136] => Array
                    [advertiser_username] => advertiser1
                    [advertiserid] => 6
                    [continuity] => 10.00
                    [conversion] => 10.00
                    [cost_type] => Per Conversion (dynamic from url)
                    [name] => advertiser1Offer2
                    [offerid] => 136