Brand List by Traffic Type
Brand record returned by GET /api/brands-list-by-traffic-type. Same merchant record as Brand List, filtered by traffic_type, with rate_type, rate_basis, and max_rate.
Fields
success
boolean
true when records are returned. false with message No active brands found when the AccessKey is valid and no brands match.
message
string
Present on an empty match: No active brands found.
merchant_id
Integer
Merchant identifier. Not permanent; may change when campaign or merchant configuration is updated.
offer_id
MD5 hash (32-character string)
Same offer_id as Brand List and Revenue Share.
campaign_id
Integer
Campaign identifier for the current tracking campaign. Not permanent.
domain
string
Official primary website domain. The same domain can appear more than once when the brand is offered in more than one country.
brand_name
string
The PubAdHub brand name for the merchant.
merchant_category
string
The brand/merchant category. May be null if no category is assigned.
verification_status
string
verified for active brands and unverified for inactive brands. Responses currently include active brands only.
click_url_homepage
URL
Homepage tracking URL. May be absent. Replace {PublisherClickID} and optional tracking placeholders.
click_url_deeplink
URL (optional)
Deeplink tracking URL. May be absent. Includes {DeepLink} plus the homepage placeholders.
country_code
string
One ISO country code per record, such as US or CA.
restricated_traffic
array of strings
Disallowed traffic methods. Empty array when none apply. Field name spelling is from the PDF.
new_deal
0 or 1
1 = new deal, 0 = existing deal.
last_updated_date
Null or YYYY-MM-DD
Most recent update date. Can be null.
commission_rate
Commission in Percentage or Currency
Commission text such as "10% CPA". Null when flat_fee applies.
flat_fee
Currency amount (optional)
Fixed commission. Returned only for cashback/flat-fee-enabled publishers when the brand uses a flat-fee model.
rate_type
String (optional)
Rate type such as CPA, CPC, or CPL. May be null.
rate_basis
String (optional)
Flat dollar or percentage. May be null.
max_rate
String (optional)
Maximum rate. Interpret using rate_basis. May be null.
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| success | boolean | true when records are returned. false with message No active brands found when the AccessKey is valid and no brands match. |
| message | string | Present on an empty match: No active brands found. |
| merchant_id | Integer | Merchant identifier. Not permanent; may change when campaign or merchant configuration is updated. |
| offer_id | MD5 hash (32-character string) | Same offer_id as Brand List and Revenue Share. |
| campaign_id | Integer | Campaign identifier for the current tracking campaign. Not permanent. |
| domain | string | Official primary website domain. The same domain can appear more than once when the brand is offered in more than one country. |
| brand_name | string | The PubAdHub brand name for the merchant. |
| merchant_category | string | The brand/merchant category. May be null if no category is assigned. |
| verification_status | string | verified for active brands and unverified for inactive brands. Responses currently include active brands only. |
| click_url_homepage | URL | Homepage tracking URL. May be absent. Replace {PublisherClickID} and optional tracking placeholders. |
| click_url_deeplink | URL (optional) | Deeplink tracking URL. May be absent. Includes {DeepLink} plus the homepage placeholders. |
| country_code | string | One ISO country code per record, such as US or CA. |
| restricated_traffic | array of strings | Disallowed traffic methods. Empty array when none apply. Field name spelling is from the PDF. |
| new_deal | 0 or 1 | 1 = new deal, 0 = existing deal. |
| last_updated_date | Null or YYYY-MM-DD | Most recent update date. Can be null. |
| commission_rate | Commission in Percentage or Currency | Commission text such as "10% CPA". Null when flat_fee applies. |
| flat_fee | Currency amount (optional) | Fixed commission. Returned only for cashback/flat-fee-enabled publishers when the brand uses a flat-fee model. |
| rate_type | String (optional) | Rate type such as CPA, CPC, or CPL. May be null. |
| rate_basis | String (optional) | Flat dollar or percentage. May be null. |
| max_rate | String (optional) | Maximum rate. Interpret using rate_basis. May be null. |
Example Payload
{
"success": true,
"data": [
{
"merchant_id": 102,
"offer_id": "ec8956637a99787bd197eacd77acce5e",
"campaign_id": 502,
"domain": "xyz.com",
"brand_name": "XYZ",
"merchant_category": "Electronics",
"verification_status": "verified",
"country_code": "US",
"restricated_traffic": [],
"new_deal": 0,
"last_updated_date": "2026-02-11",
"commission_rate": "10% CPA",
"rate_type": "CPA",
"rate_basis": "Percentage",
"max_rate": "10"
}
]
}