Offerit REST API Offer Get Details - Revision history

Offeritnick: /* GET /offer/get_details COMING SOON */

2020-07-28T17:48:21Z

‎GET /offer/get_details ***COMING SOON***

Offeritnick: /* Parameters */

2020-06-24T17:10:15Z

‎Parameters

Offeritnick: /* Parameters */

2020-06-22T21:31:21Z

‎Parameters

Offeritnick: /* Parameters */

2020-06-22T21:30:03Z

‎Parameters

Offeritnick: /* Parameters */

2020-06-22T21:03:42Z

‎Parameters

Offeritnick at 21:03, 22 June 2020

2020-06-22T21:03:32Z

Offeritnick: /* GET /offer/get_details COMING SOON */

2020-06-22T18:06:59Z

‎GET /offer/get_details ***COMING SOON***

Offeritnick: /* GET /offer/get_details */

2020-06-22T18:06:43Z

‎GET /offer/get_details

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /offer/get_details''' == '''Description''' API resource to get offer details '''Resource URL''' http..."

2020-06-22T18:06:11Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /offer/get_details''' == '''Description''' *API resource to get offer details '''Resource URL''' *<nowiki>http..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_details''' ==
'''Description'''
*API resource to get offer details

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_details</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''This API requires either offerid, name, or name_like. 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)''.'''

*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

*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, '''offerid''', 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. If not 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''' ==

'''PHP'''
<pre>
<?php
$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
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

*Response:
<pre>
Array
(
[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
)

)

)
</pre>

[[Category:Offerit API Articles]]

@@ Line 22: / Line 22: @@
 == '''Parameters''' ==
-'''''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)''.'''
+'''''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

@@ Line 22: / Line 22: @@
 == '''Parameters''' ==
-'''''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)''.'''
+'''''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)''.'''
 *offerid

@@ Line 3: / Line 3: @@
 }}
-== '''GET /offer/get_details''' <font color="red">***COMING SOON***</font> ==
+== '''GET /offer/get_details''' ==
 '''Description'''
 *API resource to get offer details

@@ Line 53: / Line 53: @@
 **'''''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, '''offerid''', 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.  If not specified, all details will be returned
+**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

@@ Line 48: / Line 48: @@
 **'''''optional'''''
 **Username of advertiser to get offers and details for
 *return_columns

Offerit REST API Offer Get Details - Revision history

Offeritnick: /* GET /offer/get_details ***COMING SOON*** */

Offeritnick: /* Parameters */

Offeritnick: /* Parameters */

Offeritnick: /* Parameters */

Offeritnick: /* Parameters */

Offeritnick at 21:03, 22 June 2020

Offeritnick: /* GET /offer/get_details ***COMING SOON*** */

Offeritnick: /* GET /offer/get_details */

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /offer/get_details''' == '''Description''' *API resource to get offer details '''Resource URL''' *http..."

Offeritnick: /* GET /offer/get_details COMING SOON */

Offeritnick: /* GET /offer/get_details COMING SOON */

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /offer/get_details''' == '''Description''' API resource to get offer details '''Resource URL''' http..."