Monetization

Endpoint: https://app.partnerboost.com/api.php?mod=medium&op=monetization_api

Auth: Partner API authentication

Required parameters

Key	Description
token	Channel API token

Optional parameters

Key	Description
type	Return format: json (default) or xml
brand_type	Brand types: TikTok, DTC, Amazon, Walmart, Indirect
brand_id	Brand ID, a series of numbers, like 66303
approval_type	Filter by approval type: Auto, Manual
offer_type	Filter by brand pricing model: CPS, CPA, CPC, CPL, CPX, CPM
relationship	Filter by your current brand relationship: Joined, Pending, Rejected, No Relationship
categories	Filter by your current brand relationship: Joined, Pending, Rejected, No Relationship
country	Filter by country. Please enter two-letter country code. Example: US, CA, FR, UK, AU
page	Current page index
limit	Number of campaigns shown per page - max 2000 campaigns per page

Return fields

Key	Description
brand_type	Brand types: TikTok,DTC, Amazon, Indirect, Walmart
total_mcid	Total number of brands called
total_page	Total number of pages
brand_id	Brand ID, a series of numbers, like 66303
mcid	Unique identifier for the brand, a series of characters, like ulike0
mid	Deprecated, for removal. This parameter is subject to removal in a future version.
merchant_name	Brand Name
comm_rate	Commission Rate
comm_detail	Commission Detail
site_url	Brand homepage url
logo	Brand Logo
categories	Brand categories
tags	Subcategories and keywords of the brand
offer_type	Brand pricing model
network_partner	Network of the Affiliate Program
avg_payment_cycle	The average days it takes for commissions approved and paid by the brands
avg_payout	Average commission rate on PartnerBoost. Formula: (Commission)/(Sale Amount)
monthly_visits	Number of monthly visits
country	Country
support_region	Support Region
brand_status	Brand Status (Online or Offline)
datetime	Date joined/removed from the program
relationship	Your brand relationship
tracking_url	Your campaign tracking link
tracking_url_short	Your campaign short link
tracking_url_smart	Your campaign smart link
RD	Cookie duration
site_desc	Description of the program
filter_words	Filter words
currency_name	The currency the program is set to track in
allow_sml	Whether or not deep linking is enabled
post_area_list	The country the brand will ship to
rep_name	The name of the contact for the brand
rep_email	The email address for the brand
support_couponordeal	Whether brand allows traffic from coupon or deal sites. 1 = allowed. 0 = not allowed. - = unknown.
support_storefront_link	Whether brand supports Amazon storefront link. true = allowed. false = not allowed.

Request:

{
  "token": "YOUR_CHANNEL_TOKEN",
  "brand_type": "DTC",
  "relationship": "Joined",
  "page": 1,
  "limit": 100
}

Response (abbreviated):

{
  "status": { "code": 0, "msg": "Success" },
  "data": [
    {
      "brand_id": "66303",
      "mcid": "example",
      "merchant_name": "Example Brand",
      "brand_type": "DTC",
      "offer_type": "CPS",
      "relationship": "Joined",
      "tracking_url_smart": "https://partnerboost.com/smart/example"
    }
  ]
}

Use results with datafeed/list and the Link Builder for monetized URLs.