List offers
curl --request GET \
--url 'https://{domain}/api/v2/advertiser/offers?api-key='{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"offers": [
{
"id": 123,
"advertiser_id": 123,
"title": "<string>",
"status": 123,
"description": "<string>",
"image": "<string>",
"gt_included_ids": "<string>",
"gt_excluded_ids": "<string>",
"extended_targeting": "<string>",
"is_featured": 123,
"is_expires": 123,
"expiration_date": "<string>",
"timezone": "<string>",
"currency": "<string>",
"ar": "<string>",
"adv_cr": "<string>",
"cpc": "<string>",
"tracking_domain_id": 123,
"traffic_types_selected": "<string>",
"traffic_types": "<string>",
"advertiser": "<string>",
"tracking_domain": "<string>",
"goals": [
{
"goal_id": 123,
"goal_name": "<string>",
"tracking_method": 123,
"conversion_status": 123,
"multiple_conversions": 123,
"has_caps": 123,
"caps": "<string>",
"alias": "<string>",
"is_default": 123,
"revenue": "<string>",
"payout": "<string>",
"goalType": {
"id": 123,
"title": "<string>",
"color": "<string>",
"type": "<string>"
},
"goal_type": 123,
"goal_type_name": "<string>",
"payoutByCountry": [
{}
],
"payoutByTier": [
{}
]
}
],
"targeting": {
"geo": {
"allowed": "<string>",
"denied": "<string>"
},
"extended_targeting": [
{}
]
},
"creatives_count": 123,
"creatives": [
{
"id": 123,
"title": "<string>",
"description": "<string>",
"type": 123,
"image": "<string>",
"image_width": 123,
"image_height": 123,
"image_size": 123,
"offer_url_id": 123,
"count_impressions": 123,
"html_code": "<string>",
"plain_text": "<string>",
"xml_feed_url": "<string>",
"xml_feed_url_tag": "<string>",
"status": 123,
"offer_id": 123,
"created": 123,
"updated": 123,
"type_selected": "<string>",
"offer_url_selected": "<string>",
"added_date": "<string>"
}
],
"links_count": 123,
"links": [
{
"id": 123,
"title": "<string>",
"type": 123,
"url": "<string>",
"preview": "<string>",
"visible_to_all_affiliates": 123,
"visible_to_specific_affiliates_only": "<string>",
"geo_allowed": "<string>",
"geo_denied": "<string>",
"rules": [
[
[
"<string>"
]
]
],
"percent": 123,
"status": 123,
"offer_id": 123,
"created": 123,
"updated": 123,
"type_selected": "<string>"
}
],
"live_stats": {
"key": "<string>",
"current": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
},
"previous": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
}
},
"visible_type_selected": [
{}
],
"categories": [
{}
]
}
]
}
}Offers
List offers
Returns paginated list of offers available to the authenticated advertiser. Alias: /api/v2/brand/offers.
GET
/
api
/
v2
/
advertiser
/
offers
List offers
curl --request GET \
--url 'https://{domain}/api/v2/advertiser/offers?api-key='{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"offers": [
{
"id": 123,
"advertiser_id": 123,
"title": "<string>",
"status": 123,
"description": "<string>",
"image": "<string>",
"gt_included_ids": "<string>",
"gt_excluded_ids": "<string>",
"extended_targeting": "<string>",
"is_featured": 123,
"is_expires": 123,
"expiration_date": "<string>",
"timezone": "<string>",
"currency": "<string>",
"ar": "<string>",
"adv_cr": "<string>",
"cpc": "<string>",
"tracking_domain_id": 123,
"traffic_types_selected": "<string>",
"traffic_types": "<string>",
"advertiser": "<string>",
"tracking_domain": "<string>",
"goals": [
{
"goal_id": 123,
"goal_name": "<string>",
"tracking_method": 123,
"conversion_status": 123,
"multiple_conversions": 123,
"has_caps": 123,
"caps": "<string>",
"alias": "<string>",
"is_default": 123,
"revenue": "<string>",
"payout": "<string>",
"goalType": {
"id": 123,
"title": "<string>",
"color": "<string>",
"type": "<string>"
},
"goal_type": 123,
"goal_type_name": "<string>",
"payoutByCountry": [
{}
],
"payoutByTier": [
{}
]
}
],
"targeting": {
"geo": {
"allowed": "<string>",
"denied": "<string>"
},
"extended_targeting": [
{}
]
},
"creatives_count": 123,
"creatives": [
{
"id": 123,
"title": "<string>",
"description": "<string>",
"type": 123,
"image": "<string>",
"image_width": 123,
"image_height": 123,
"image_size": 123,
"offer_url_id": 123,
"count_impressions": 123,
"html_code": "<string>",
"plain_text": "<string>",
"xml_feed_url": "<string>",
"xml_feed_url_tag": "<string>",
"status": 123,
"offer_id": 123,
"created": 123,
"updated": 123,
"type_selected": "<string>",
"offer_url_selected": "<string>",
"added_date": "<string>"
}
],
"links_count": 123,
"links": [
{
"id": 123,
"title": "<string>",
"type": 123,
"url": "<string>",
"preview": "<string>",
"visible_to_all_affiliates": 123,
"visible_to_specific_affiliates_only": "<string>",
"geo_allowed": "<string>",
"geo_denied": "<string>",
"rules": [
[
[
"<string>"
]
]
],
"percent": 123,
"status": 123,
"offer_id": 123,
"created": 123,
"updated": 123,
"type_selected": "<string>"
}
],
"live_stats": {
"key": "<string>",
"current": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
},
"previous": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
}
},
"visible_type_selected": [
{}
],
"categories": [
{}
]
}
]
}
}Documentation Index
Fetch the complete documentation index at: https://docs.scaleo.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key passed as query parameter. User must have api_status enabled.
Query Parameters
Page number.
Items per page.
Sort field.
Sort direction.
Available options:
asc, desc Search by text or ID.
Comma-separated column keys.
Was this page helpful?
⌘I