Skip to content
PubAdHub
Start

Brand List API

Publisher API

Use the Brand List API to retrieve merchant/brand records, including brand name, merchant category, verification status, tracking URLs (homepage and deeplink), country eligibility, traffic restrictions, deal flags, and commission information. The API uses GET and requires an AccessKey HTTP header for authorization. Documented commission fields include commission_rate and optional flat_fee. Use offer_id to match Brand List records with the Revenue Share API. Tracking URLs include placeholders for clickid (required) and optional subi, psorc, pcat, subid1–subid5, and dl on deeplink URLs.

Base URL https://statsapi.pubadhub.com
GET /api/brands-list
warning

Cashback traffic

If restricated_traffic contains "Incentivized Traffic", exclude the brand from cashback traffic. Check restricated_traffic before promoting a brand through cashback campaigns. If "Incentivized Traffic" is not listed, the brand may be used for cashback traffic, subject to any other applicable traffic restrictions.
lock

Authentication

The request must include the AccessKey HTTP request header with your assigned key value.

AccessKey: {AccessKey}

Headers

AccessKey REQUIRED

{AccessKey}

The request must include the AccessKey HTTP request header with your assigned key value.

API format

API Format 
https://statsapi.pubadhub.com/api/brands-list

Request example

GET /api/brands-list HTTP/1.1
Host: statsapi.pubadhub.com
AccessKey: {AccessKey}

Response

Returns brand/merchant records. HTTP status code: NEEDS_REVIEW (not specified in the PDF).

JSON 
{
    "success": true,
    "data": [
        {
            "merchant_id": 101,
            "offer_id": "38b3eff8baf56627478ec76a704e9b52",
            "campaign_id": 501,
            "domain": "abc.com",
            "brand_name": "ABC",
            "merchant_category": "Home and Living",
            "verification_status": "verified",
            "click_url_homepage": "https://offers.choicedeals.com/track?encyp=Lp4MFxzHP4IG1bqIDtiEpvzx+3RdLspJK3aS0jauqYPM+ruscTQTd8ctasSpbrjG&clickid={PublisherClickID}&subi={SubId}&psorc={PUBLISHERSOURCE}&pcat={SOURCECATEGORY}&subid1={SubId1}&subid2={SubId2}&subid3={SubId3}&subid4={SubId4}&subid5={SubId5}&cc=US",
            "click_url_deeplink": "https://offers.choicedeals.com/track?encyp=Lp4MFxzHP4IG1bqIDtiEpvzx+3RdLspJK3aS0jauqYPM+ruscTQTd8ctasSpbrjG&clickid={PublisherClickID}&dl={DeepLink}&subi={SubId}&psorc={PUBLISHERSOURCE}&cc=US",
            "country_code": "US",
            "restricated_traffic": [],
            "new_deal": 0,
            "last_updated_date": "2026-02-11",
            "commission_rate": null,
            "flat_fee": "$20"
        },
        {
            "merchant_id": 102,
            "offer_id": "ec8956637a99787bd197eacd77acce5e",
            "campaign_id": 502,
            "domain": "xyz.com",
            "brand_name": "XYZ",
            "merchant_category": "Electronics",
            "verification_status": "verified",
            "click_url_homepage": "https://offers.choicedeals.com/track?encyp=Lp4MFxzHP4IG1bqIDtiEpvzx+3RdLspJK3aS0jauqYPM+ruscTQTd8ctasSpbrjG&clickid={PublisherClickID}&subi={SubId}&psorc={PUBLISHERSOURCE}&cc=US",
            "click_url_deeplink": "https://offers.choicedeals.com/track?encyp=Lp4MFxzHP4IG1bqIDtiEpvzx+3RdLspJK3aS0jauqYPM+ruscTQTd8ctasSpbrjG&clickid={PublisherClickID}&dl={DeepLink}&subi={SubId}&psorc={PUBLISHERSOURCE}&pcat={SOURCECATEGORY}&subid1={SubId1}&subid2={SubId2}&subid3={SubId3}&subid4={SubId4}&subid5={SubId5}&cc=US",
            "country_code": "US",
            "restricated_traffic": [],
            "new_deal": 0,
            "last_updated_date": "2026-02-11",
            "commission_rate": "10% CPA"
        }
    ]
}

Response fields

merchant_id Integer

Merchant identifier associated with the brand. This identifier is not permanent and may change when the underlying campaign or merchant configuration is updated.

Example: 101

offer_id MD5 hash (32-character string)

Same offer_id as Revenue Share. Use it to match Brand List with Revenue Share.

Example: 38b3eff8baf56627478ec76a704e9b52

campaign_id Integer

Campaign identifier associated with the brand's current tracking campaign. This identifier is not permanent and may change when the underlying campaign is updated.

Example: 501

domain string

The official primary website domain of the brand or advertiser. This is the stable and unique identifier for the brand and will not appear more than once in a single Brand List API response.

Example: zennioptical.com

brand_name string

The PubAdHub brand name for the merchant.

Example: Zenni Optical

merchant_category string

The brand/merchant category. May be null if no category is assigned.

Example: Footwear and Accessories

verification_status string

Brand status. Returned as verified for active brands and unverified for inactive brands. Brand List responses currently include active brands only, so this value is verified.

Example: verified

click_url_homepage URL

Affiliate tracking URL that directs users to the brand's main homepage. Replace documented placeholders such as {PublisherClickID} before sending traffic.

click_url_deeplink URL (optional)

Affiliate tracking URL that sends users to a specific page (product, category, offer). Includes {DeepLink} plus the same click and sub ID placeholders as the homepage URL.

country_code string

Country or countries where the offer is valid or allowed (ISO country codes like US, CA).

Example: US,CA etc.

restricated_traffic string / array

Types of traffic sources or promotional methods that are not allowed for this brand. Field name spelling is from the PDF.

Example: Coupons, Promo Codes, Incentivized Traffic, Paid Search, Email Spam, Gift Cards

new_deal 0 or 1

Indicates whether the brand or offer is newly added (1 = new deal, 0 = existing deal)

last_updated_date Null or YYYY-MM-DD

The most recent date when this record was updated (YYYY-MM-DD format). Can be NULL if not updated.

Example: 2026-01-19

commission_rate Commission in Percentage or Currency

The commission rate or commission information provided for the brand. The value may be returned as descriptive text, such as "10% CPA". When a flat_fee applies, commission_rate is returned as null.

Example: null | 10% CPA

flat_fee Currency amount (optional)

The fixed commission amount paid for a qualifying transaction. This field is returned only for publishers enabled for cashback and flat-fee offers, and only when the brand uses a flat-fee commission model. When present, commission_rate is null.

Example: $20

Tracking URLs

Use click_url_homepage for traffic directed to the brand's main homepage. Use click_url_deeplink when sending users to a specific page (product, category, offer). Replace the placeholders in those URLs before sending traffic. These values are not Brand List request parameters.

click_url_homepage

click_url_homepage 
https://offers.choicedeals.com/track?encyp=Lp4MFxzHP4IG1bqIDtiEpvzx+3RdLspJK3aS0jauqYPM+ruscTQTd8ctasSpbrjG&clickid={PublisherClickID}&subi={SubId}&psorc={PUBLISHERSOURCE}&pcat={SOURCECATEGORY}&subid1={SubId1}&subid2={SubId2}&subid3={SubId3}&subid4={SubId4}&subid5={SubId5}&cc=US

click_url_deeplink

click_url_deeplink 
https://offers.choicedeals.com/track?encyp=Lp4MFxzHP4IG1bqIDtiEpvzx+3RdLspJK3aS0jauqYPM+ruscTQTd8ctasSpbrjG&clickid={PublisherClickID}&dl={DeepLink}&subi={SubId}&psorc={PUBLISHERSOURCE}&pcat={SOURCECATEGORY}&subid1={SubId1}&subid2={SubId2}&subid3={SubId3}&subid4={SubId4}&subid5={SubId5}&cc=US

Redirect URL parameters

Redirect URL parameters. clickid is required. dl is used with the deeplink URL. subi, psorc, pcat, and subid1–subid5 are optional. clickid, subi, and subid1–subid5 are returned in the Revenue API.

clickid
string REQUIRED

The publisher can pass their unique click ID in this parameter. This click ID is used to identify the click and will be returned in the Revenue API.

Example: &clickid={PublisherClickID}

dl
URL Optional / For Deeplink URL

Used with the Deeplink URL when the publisher wants to redirect the user to a specific page of the advertiser, such as a product, category, or offer page.

Example: &dl={DeepLink}

subi
string OPTIONAL

The publisher can pass their Sub ID in this parameter. The value will be available in the Revenue API for tracking and reporting purposes.

Example: &subi={SubId}

psorc
string OPTIONAL

Allows the publisher to pass their traffic/source information, if applicable.

Example: &psorc={PUBLISHERSOURCE}

subid1
string OPTIONAL

An optional publisher-defined alphanumeric tracking value. The value will be returned in the Revenue API.

Example: &subid1={SUBID1}

subid2
string OPTIONAL

An optional publisher-defined alphanumeric tracking value. The value will be returned in the Revenue API.

Example: &subid2={SUBID2}

subid3
string OPTIONAL

An optional publisher-defined alphanumeric tracking value. The value will be returned in the Revenue API.

Example: &subid3={SUBID3}

subid4
string OPTIONAL

An optional publisher-defined alphanumeric tracking value. The value will be returned in the Revenue API.

Example: &subid4={SUBID4}

subid5
string OPTIONAL

An optional publisher-defined alphanumeric tracking value. The value will be returned in the Revenue API.

Example: &subid5={SUBID5}

pcat
string OPTIONAL

An optional publisher-defined source category tracking parameter. The value is used to capture the publisher's source category.

Example: &pcat={SOURCECATEGORY}

Notes

info
Protocol: HTTP GET → JSON response. Authentication: AccessKey header. No additional request body is documented.
info
To retrieve the brand list, send a GET request to https://statsapi.pubadhub.com/api/brands-list with AccessKey: {AccessKey}.
info
Use click_url_homepage for homepage traffic and click_url_deeplink for deeplink traffic when available. Replace {PublisherClickID} (required). Optional: {SubId}, {PUBLISHERSOURCE}, {SOURCECATEGORY}, {SubId1}–{SubId5}. Use {DeepLink} only on the deeplink URL.
info
The redirect domain used in tracking URLs may change over time based on campaign updates. If it changes, tracking URLs using the previous redirect domain will continue to work.
info
The domain field is the stable and unique brand identifier. merchant_id and campaign_id are not permanent and may change when the underlying campaign is updated. Use offer_id to match Brand List records with the Revenue Share API; this identifier remains consistent across both APIs. The same brand domain will not appear more than once in a single response.
info
If restricated_traffic contains "Incentivized Traffic", exclude the brand from cashback traffic. Check restricated_traffic before promoting a brand through cashback campaigns. If "Incentivized Traffic" is not listed in restricated_traffic, the brand may be used for cashback traffic, subject to any other applicable traffic restrictions.
info
When flat_fee is present, commission_rate is null. flat_fee is returned only for publishers enabled for cashback and flat-fee offers, and only when the brand uses a flat-fee commission model.
info
For optimal reliability and performance: set appropriate timeout values; enable redirect handling; use a stable HTTP version; implement proper error and timeout handling.
info
Integration checklist: configure GET /api/brands-list on https://statsapi.pubadhub.com; implement AccessKey header; map response fields including offer_id, brand_name, merchant_category, and verification_status; use click_url_homepage / click_url_deeplink as documented, substituting clickid and optional tracking parameters; handle commission_rate / flat_fee; review restricated_traffic and country_code for offer compliance; test a successful brand list response end to end.

Original PDF

This page is sourced from the official API PDF. The original file remains available.

picture_as_pdf View Original PDF download Download PDF

Brand List API.pdf

Related documentation

database

Brand List Item

Brand or advertiser record returned by GET /api/brands-list.

Open arrow_forward
POST

Revenue Share Report

Retrieve click-level, source-level, or date-wise revenue share data including gross revenue, publisher earnings, click counts, transaction identifiers, and publisher tracking values (subid1–subid5).

https://statsapi.pubadhub.com/api/reporting/revenue-share
Open arrow_forward
Previous
arrow_back Publisher APIs
Next
Brand List by Traffic Type arrow_forward
play_circle

Try it out

Fill the fields below, copy the generated cURL, or send a live request.

GET https://statsapi.pubadhub.com/api/brands-list
cURL 

        


        

            
            
        


        

            

                Response
                
                    Status: