Offer Groups
Operations for offer groups
Find All
GET
/v1/networks/offergroups
Relationships
This endpoint supports the following additional relationships. Refer to our User Guide for usage.
| Value | Description |
|---|---|
| audits | Includes the offer group’s audits information |
| reporting | Includes the offer group’s reporting for today |
Request Example
cURL
curl --request GET 'https://api.eflow.team/v1/networks/offergroups' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
"offer_groups": [
{
"network_offer_group_id": 1,
"network_id": 1,
"network_advertiser_id": 13,
"name": "Expedia Travel",
"internal_notes": "",
"offer_group_status": "deleted",
"is_caps_enabled": true,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 100,
"monthly_conversion_cap": 0,
"global_conversion_cap": 1000,
"daily_payout_cap": 0,
"weekly_payout_cap": 0,
"monthly_payout_cap": 0,
"global_payout_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"time_created": 1602783082,
"time_saved": 1602783082,
"relationship": {
"advertiser": {
"network_advertiser_id": 13,
"network_id": 1,
"name": "Michael Good Inc.",
"account_status": "active",
"network_employee_id": 2,
"internal_notes": "",
"address_id": 0,
"is_contact_address_enabled": false,
"sales_manager_id": 0,
"is_expose_publisher_reporting_data": null,
"default_currency_id": "USD",
"platform_name": "",
"platform_url": "",
"platform_username": "",
"reporting_timezone_id": 67,
"accounting_contact_email": "",
"verification_token": "",
"offer_id_macro": "oid",
"affiliate_id_macro": "affid",
"time_created": 1602783082,
"time_saved": 1602783082,
"attribution_method": "last_touch",
"email_attribution_method": "last_affiliate_attribution"
},
"labels": {
"total": 0,
"entries": []
},
"network_offer_ids": [
5,
6,
22
],
"remaining_caps": {
"remaining_daily_payout_cap": -1000,
"remaining_daily_revenue_cap": -1000,
"remaining_daily_conversion_cap": -1000,
"remaining_daily_click_cap": -1000,
"remaining_weekly_payout_cap": -1000,
"remaining_weekly_revenue_cap": -1000,
"remaining_weekly_conversion_cap": 100,
"remaining_weekly_click_cap": -1000,
"remaining_monthly_payout_cap": -1000,
"remaining_monthly_revenue_cap": -1000,
"remaining_monthly_conversion_cap": -1000,
"remaining_monthly_click_cap": -1000,
"remaining_global_payout_cap": -1000,
"remaining_global_revenue_cap": -1000,
"remaining_global_conversion_cap": 1000,
"remaining_global_click_cap": -1000
}
}
}
]
}
Find By ID
GET
/v1/networks/offergroups/:offerGroupId
Relationships
This endpoint supports the following additional relationships. Refer to our User Guide for usage.
| Value | Description |
|---|---|
| audits | Includes the offer group’s audits information |
| reporting | Includes the offer group’s reporting for today |
Path Parameters
| Parameter | Description |
|---|---|
| offerId | The ID of the offer group you want to fetch |
Request Example
cURL
curl --request GET 'https://api.eflow.team/v1/networks/offergroups/<INSERT OFFER GROUP ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
"network_offer_group_id": 1,
"network_id": 1,
"network_advertiser_id": 13,
"name": "Expedia Travel",
"internal_notes": "",
"offer_group_status": "deleted",
"is_caps_enabled": true,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 100,
"monthly_conversion_cap": 0,
"global_conversion_cap": 1000,
"daily_payout_cap": 0,
"weekly_payout_cap": 0,
"monthly_payout_cap": 0,
"global_payout_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"time_created": 1602783082,
"time_saved": 1602783082,
"relationship": {
"advertiser": {
"network_advertiser_id": 13,
"network_id": 1,
"name": "Michael Good Inc.",
"account_status": "active",
"network_employee_id": 2,
"internal_notes": "",
"address_id": 0,
"is_contact_address_enabled": false,
"sales_manager_id": 0,
"is_expose_publisher_reporting_data": null,
"default_currency_id": "USD",
"platform_name": "",
"platform_url": "",
"platform_username": "",
"reporting_timezone_id": 67,
"accounting_contact_email": "",
"verification_token": "",
"offer_id_macro": "oid",
"affiliate_id_macro": "affid",
"time_created": 1602783082,
"time_saved": 1602783082,
"attribution_method": "last_touch",
"email_attribution_method": "last_affiliate_attribution"
},
"labels": {
"total": 0,
"entries": []
},
"network_offer_ids": [
5,
6,
22
],
"remaining_caps": {
"remaining_daily_payout_cap": -1000,
"remaining_daily_revenue_cap": -1000,
"remaining_daily_conversion_cap": -1000,
"remaining_daily_click_cap": -1000,
"remaining_weekly_payout_cap": -1000,
"remaining_weekly_revenue_cap": -1000,
"remaining_weekly_conversion_cap": 100,
"remaining_weekly_click_cap": -1000,
"remaining_monthly_payout_cap": -1000,
"remaining_monthly_revenue_cap": -1000,
"remaining_monthly_conversion_cap": -1000,
"remaining_monthly_click_cap": -1000,
"remaining_global_payout_cap": -1000,
"remaining_global_revenue_cap": -1000,
"remaining_global_conversion_cap": 1000,
"remaining_global_click_cap": -1000
}
}
}
Create
POST
/v1/networks/offergroups
Body Params
network_advertiser_id
int
ID of the advertiser for the offer group.
name
string
internal_notes
string
offer_group_status
string
Status of the offer group. Can be one of the following values: active, paused or deleted.
is_caps_enabled
boolean
Whether caps are enabled. When false, voids all types of caps and custom caps.
daily_conversion_cap
int
Limit to the number of unique conversions in one day.
weekly_conversion_cap
int
Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59)
monthly_conversion_cap
int
Limit to the number of unique conversions in one month.
global_conversion_cap
int
Limit to the total number of unique conversion at the offer level.
daily_payout_cap
int
Limit to the affiliate’s payout for one day.
weekly_payout_cap
int
Limit to the affiliate’s payout for a week (Monday midnight to Sunday 23h59:59)
monthly_payout_cap
int
Limit to the affiliate’s payout for one month.
global_payout_cap
int
Limit to the affiliate’s total payout at the offer level.
daily_revenue_cap
int
Limit to the network’s revenue for one day.
weekly_revenue_cap
int
Limit to the network’s revenue for a week (Monday midnight to Sunday 23h59:59)
monthly_revenue_cap
int
Limit to the network’s revenue for one month.
global_revenue_cap
int
Limit to the network’s total revenue at the offer level.
daily_click_cap
int
Limit to the number of unique clicks in one day.
weekly_click_cap
int
Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).
monthly_click_cap
int
Limit to the number of unique clicks in one month.
global_click_cap
int
Limit to the total number of unique clicks at the offer level.
network_offer_ids
int array
Ids of the offers included in the offer group.
labels
string array
Payload Example
{
"network_advertiser_id": 13,
"name": "",
"internal_notes": "",
"offer_group_status": "active",
"is_caps_enabled": false,
"daily_click_cap": 0,
"daily_conversion_cap": 0,
"daily_payout_cap": 0,
"daily_revenue_cap": 0,
"global_click_cap": 0,
"global_conversion_cap": 0,
"global_payout_cap": 0,
"global_revenue_cap": 0,
"internal_notes": "",
"daily_conversion_cap": 0,
"weekly_conversion_cap": 100,
"monthly_conversion_cap": 0,
"global_conversion_cap": 1000,
"daily_payout_cap": 0,
"weekly_payout_cap": 0,
"monthly_payout_cap": 0,
"global_payout_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"network_offer_ids": [
7,
10
],
"labels": [
"Sport",
"School"
]
}
Request Example
cURL
curl --request POST \
--url 'https://api.eflow.team/v1/networks/offergroups' \
--header 'x-eflow-api-key: <INSERT API KEY>' \
--header 'content-type: application/json' \
--data '<INSERT PAYLOAD>'
Response
{
"network_offer_group_id": 6,
"network_id": 1,
"network_advertiser_id": 13,
"name": "",
"internal_notes": "",
"offer_group_status": "active",
"is_caps_enabled": false,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 100,
"monthly_conversion_cap": 0,
"global_conversion_cap": 1000,
"daily_payout_cap": 0,
"weekly_payout_cap": 0,
"monthly_payout_cap": 0,
"global_payout_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"time_created": 1603822910,
"time_saved": 1603822910,
"relationship": {
"advertiser": {
"network_advertiser_id": 13,
"network_id": 1,
"name": "Michael Good Inc.",
"account_status": "active",
"network_employee_id": 2,
"internal_notes": "",
"address_id": 0,
"is_contact_address_enabled": false,
"sales_manager_id": 0,
"is_expose_publisher_reporting_data": null,
"default_currency_id": "USD",
"platform_name": "",
"platform_url": "",
"platform_username": "",
"reporting_timezone_id": 67,
"accounting_contact_email": "",
"verification_token": "",
"offer_id_macro": "oid",
"affiliate_id_macro": "affid",
"time_created": 1602783082,
"time_saved": 1602783082,
"attribution_method": "last_touch",
"email_attribution_method": "last_affiliate_attribution"
},
"labels": {
"total": 2,
"entries": [
"School",
"Sport"
]
},
"network_offer_ids": [
7,
10
],
"remaining_caps": {
"remaining_daily_payout_cap": -1000,
"remaining_daily_revenue_cap": -1000,
"remaining_daily_conversion_cap": -1000,
"remaining_daily_click_cap": -1000,
"remaining_weekly_payout_cap": -1000,
"remaining_weekly_revenue_cap": -1000,
"remaining_weekly_conversion_cap": 100,
"remaining_weekly_click_cap": -1000,
"remaining_monthly_payout_cap": -1000,
"remaining_monthly_revenue_cap": -1000,
"remaining_monthly_conversion_cap": -1000,
"remaining_monthly_click_cap": -1000,
"remaining_global_payout_cap": -1000,
"remaining_global_revenue_cap": -1000,
"remaining_global_conversion_cap": 1000,
"remaining_global_click_cap": -1000
}
}
}
Update
PUT
/v1/networks/offergroups
Body Params
network_advertiser_id
int
ID of the advertiser for the offer group.
name
string
internal_notes
string
offer_group_status
string
Status of the offer group. Can be one of the following values: active, paused or deleted.
is_caps_enabled
boolean
Whether caps are enabled. When false, voids all types of caps and custom caps.
daily_conversion_cap
int
Limit to the number of unique conversions in one day.
weekly_conversion_cap
int
Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59)
monthly_conversion_cap
int
Limit to the number of unique conversions in one month.
global_conversion_cap
int
Limit to the total number of unique conversion at the offer level.
daily_payout_cap
int
Limit to the affiliate’s payout for one day.
weekly_payout_cap
int
Limit to the affiliate’s payout for a week (Monday midnight to Sunday 23h59:59)
monthly_payout_cap
int
Limit to the affiliate’s payout for one month.
global_payout_cap
int
Limit to the affiliate’s total payout at the offer level.
daily_revenue_cap
int
Limit to the network’s revenue for one day.
weekly_revenue_cap
int
Limit to the network’s revenue for a week (Monday midnight to Sunday 23h59:59)
monthly_revenue_cap
int
Limit to the network’s revenue for one month.
global_revenue_cap
int
Limit to the network’s total revenue at the offer level.
daily_click_cap
int
Limit to the number of unique clicks in one day.
weekly_click_cap
int
Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).
monthly_click_cap
int
Limit to the number of unique clicks in one month.
global_click_cap
int
Limit to the total number of unique clicks at the offer level.
network_offer_ids
int array
Ids of the offers included in the offer group.
labels
string array
Payload Example
{
"network_advertiser_id": 13,
"name": "",
"internal_notes": "",
"offer_group_status": "active",
"is_caps_enabled": false,
"daily_click_cap": 0,
"daily_conversion_cap": 0,
"daily_payout_cap": 0,
"daily_revenue_cap": 0,
"global_click_cap": 0,
"global_conversion_cap": 0,
"global_payout_cap": 0,
"global_revenue_cap": 0,
"internal_notes": "",
"daily_conversion_cap": 0,
"weekly_conversion_cap": 100,
"monthly_conversion_cap": 0,
"global_conversion_cap": 1000,
"daily_payout_cap": 0,
"weekly_payout_cap": 0,
"monthly_payout_cap": 0,
"global_payout_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"network_offer_ids": [
7,
10
],
"labels": [
"Sport",
"School"
]
}
Request Example
cURL
curl --request PUT \
--url 'https://api.eflow.team/v1/networks/offergroups/<INSERT OFFER GROUP ID>' \
--header 'x-eflow-api-key: <INSERT API KEY>' \
--header 'content-type: application/json' \
--data '<INSERT PAYLOAD>'
Response
{
"network_offer_group_id": 6,
"network_id": 1,
"network_advertiser_id": 13,
"name": "",
"internal_notes": "",
"offer_group_status": "active",
"is_caps_enabled": false,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 100,
"monthly_conversion_cap": 0,
"global_conversion_cap": 1000,
"daily_payout_cap": 0,
"weekly_payout_cap": 0,
"monthly_payout_cap": 0,
"global_payout_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"time_created": 1603822910,
"time_saved": 1603822910,
"relationship": {
"advertiser": {
"network_advertiser_id": 13,
"network_id": 1,
"name": "Michael Good Inc.",
"account_status": "active",
"network_employee_id": 2,
"internal_notes": "",
"address_id": 0,
"is_contact_address_enabled": false,
"sales_manager_id": 0,
"is_expose_publisher_reporting_data": null,
"default_currency_id": "USD",
"platform_name": "",
"platform_url": "",
"platform_username": "",
"reporting_timezone_id": 67,
"accounting_contact_email": "",
"verification_token": "",
"offer_id_macro": "oid",
"affiliate_id_macro": "affid",
"time_created": 1602783082,
"time_saved": 1602783082,
"attribution_method": "last_touch",
"email_attribution_method": "last_affiliate_attribution"
},
"labels": {
"total": 2,
"entries": [
"School",
"Sport"
]
},
"network_offer_ids": [
7,
10
],
"remaining_caps": {
"remaining_daily_payout_cap": -1000,
"remaining_daily_revenue_cap": -1000,
"remaining_daily_conversion_cap": -1000,
"remaining_daily_click_cap": -1000,
"remaining_weekly_payout_cap": -1000,
"remaining_weekly_revenue_cap": -1000,
"remaining_weekly_conversion_cap": 100,
"remaining_weekly_click_cap": -1000,
"remaining_monthly_payout_cap": -1000,
"remaining_monthly_revenue_cap": -1000,
"remaining_monthly_conversion_cap": -1000,
"remaining_monthly_click_cap": -1000,
"remaining_global_payout_cap": -1000,
"remaining_global_revenue_cap": -1000,
"remaining_global_conversion_cap": 1000,
"remaining_global_click_cap": -1000
}
}
}