v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB

Offer Groups

Get Offer Group by ID

get/networks/offergroups/{offerGroupId}

Path parameters

offerGroupIdinteger required

The offer group ID.

Query parameters

relationship'audits' | 'reporting'

Include related data (audits or today's reporting).

Response

network_offer_group_idinteger

Unique offer group ID.

network_idinteger

Network ID.

network_advertiser_idinteger

ID of the advertiser for the offer group.

namestring

Name of the offer group.

internal_notesstring

Internal notes about the offer group.

offer_group_status'active' | 'paused' | 'deleted'

Status of the offer group. Can be one of the following values: active, paused or deleted.

is_caps_enabledboolean

Whether caps are enabled. When false, voids all types of caps and custom caps.

daily_conversion_capinteger

Limit to the number of unique conversions in one day.

weekly_conversion_capinteger

Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59).

monthly_conversion_capinteger

Limit to the number of unique conversions in one month.

global_conversion_capinteger

Limit to the total number of unique conversions at the offer level.

daily_payout_capnumber

Limit to the affiliate's payout for one day.

weekly_payout_capnumber

Limit to the affiliate's payout for a week (Monday midnight to Sunday 23h59:59).

monthly_payout_capnumber

Limit to the affiliate's payout for one month.

global_payout_capnumber

Limit to the affiliate's total payout at the offer level.

daily_revenue_capnumber

Limit to the network's revenue for one day.

weekly_revenue_capnumber

Limit to the network's revenue for a week (Monday midnight to Sunday 23h59:59).

monthly_revenue_capnumber

Limit to the network's revenue for one month.

global_revenue_capnumber

Limit to the network's total revenue at the offer level.

daily_click_capinteger

Limit to the number of unique clicks in one day.

weekly_click_capinteger

Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).

monthly_click_capinteger

Limit to the number of unique clicks in one month.

global_click_capinteger

Limit to the total number of unique clicks at the offer level.

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

is_soft_capboolean

Whether soft caps are enabled for this offer group.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "advertiser": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    }
  }
}